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

服务地址

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

接口详情

PUT

/api/version/confirmPlatformVersion

版本管理用户确认版本 OperationId: confirmPlatformVersion

调用方法

PUT /api/version/confirmPlatformVersion

参数

无

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/userPerson/updateUserMobilePhone

用户个人管理修改手机号 OperationId: updateUserMobilePhone

调用方法

PUT /api/userPerson/updateUserMobilePhone

参数

名称	位置	必填	类型	说明
newMobilePhone	query	是	string	新手机号
newCaptcha	query	是	string	新手机号验证码
oldCaptcha	query	否	string	旧手机号验证码

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/userPerson/updateUserEmail

用户个人管理修改邮箱 OperationId: updateUserEmail

调用方法

PUT /api/userPerson/updateUserEmail

参数

名称	位置	必填	类型	说明
newEmail	query	是	string	新邮箱
newCaptcha	query	是	string	新邮箱验证码
oldCaptcha	query	否	string	旧邮箱验证码

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/userPerson/updatePassword

用户个人管理修改密码 OperationId: updatePassword

调用方法

PUT /api/userPerson/updatePassword

参数

名称	位置	必填	类型	说明
oldPassword	query	是	string	旧密码
newPassword	query	是	string	新密码
captcha	query	否	string	验证码

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/userPasswordRule/update/{merchantId}

用户密码规则管理编辑密码规则 OperationId: updatePasswordRule

调用方法

PUT /api/userPasswordRule/update/{merchantId}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)	商户号ID	1

请求体

Content-Type: application/json 必填: 是 类型: PasswordRuleDTO$UpdateDTO com.leadwaycloud.system.model.dto.PasswordRuleDTO$UpdateDTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
maxLength	integer(int32)	否	最大长度
minLength	integer(int32)	否	最小长度
neverExpiresAllowed	boolean	否	是否允许永不过期
numericDigitRequired	boolean	否	是否必须包含数字
specialCharactersAllowed	boolean	否	允许特殊符号
specialCharactersRequired	boolean	否	是否必须包含特殊符号
upperCaseCharactersRequired	boolean	否	必需包含大写字母
lockoutDuration	integer(int32)	否	自动签出时间(分)
validateDuration	integer(int32)	否	有效期(天)
expirationNotification	boolean	否	过期提醒
defaultPasswordValidateDuration	integer(int32)	否	默认密码有效期

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

PUT

/api/userMall/yhd/updateUserMobilePhone

商城用户管理修改手机号 OperationId: updateUserMobilePhone_1

调用方法

PUT /api/userMall/yhd/updateUserMobilePhone

参数

名称	位置	必填	类型	说明
newMobilePhone	query	是	string	新手机号
newCaptcha	query	是	string	新手机号验证码
oldCaptcha	query	否	string	旧手机号验证码

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/user/update/{id}

用户管理编辑用户 OperationId: update

调用方法

PUT /api/user/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID

请求体

Content-Type: application/json 必填: 是 类型: UserDTO$UpdateDTO com.leadwaycloud.system.model.dto.UserDTO$UpdateDTO

名称	类型	必填	说明	示例
userName	string	否	登录名称
name	string	否	用户名称	"hyj"
language	string	否	系统语言	"zh_CN"
image	string	否	图片	"xxxxx"
status	string	否	状态	"ACTIVE"
readVersionInfo	boolean	否	是否已读更新版本信息
email	string	否	邮箱
sign	string	否	签名
password	string	否	默认密码
forceUpdatePassword	boolean	否	是否强制修改密码
mobilePhone	string	否	手机号	"131"
allowLoginChannel	boolean	否	允许登陆渠道(ERP:ERP_BACKEND,电商平台:ECOMMERCE_PLATFORM,供应商平台:SUPPLIER_PLATFORM)。如果有多个用,逗号隔开
userAuditStatus	string	否	用户审核状态
idaasId	string	否	idaas唯一ID
externalCode	string	否	外部编号

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResUser	否

PUT

/api/user/shell/updatePassword

用户管理-壳牌修改密码 OperationId: updatePassword_1

调用方法

PUT /api/user/shell/updatePassword

参数

无

请求体

Content-Type: application/json 必填: 是 类型: UpdateUserPasswordDTO com.leadwaycloud.system.shell.model.dto.UpdateUserPasswordDTO

名称	类型	必填	说明
password	string	是	密码
verificationCode	string	是	验证码
oldPassword	string	是	旧密码

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/user/assignPermissions/{id}/{companyId}

用户管理分配权限 OperationId: assignPermissions

调用方法

PUT /api/user/assignPermissions/{id}/{companyId}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID
companyId	path	是	integer(int64)

请求体

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

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

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResUser	否

PUT

/api/user/assignManageableCompany/{id}

用户管理分配可管理公司 OperationId: assignManageableCompany

调用方法

PUT /api/user/assignManageableCompany/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID

请求体

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

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

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResUser	否

PUT

/api/uom/update/{id}

计量单位信息修改计量单位接口 OperationId: update_1

调用方法

PUT /api/uom/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

Content-Type: application/json 必填: 是 类型: SystemUomDTO$UpdateDTO com.leadwaycloud.system.model.dto.SystemUomDTO$UpdateDTO

名称	类型	必填	说明	示例
code	string	否	编号	"1"
name	string	否	名称	"公斤"
symbol	string	否	符号	"kg"
ratio	number(double)	否	换算率
active	boolean	否	是否可用	true
shortName	string	否	简称
isoShortName	string	否	ISO名称

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysUom	否

PUT

/api/trip-line/update/{id}

航线管理修改航线数据 OperationId: updateTripLine

调用方法

PUT /api/trip-line/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	49

请求体

Content-Type: application/json 必填: 是 类型: TripLineDTO$UpdateDTO com.leadwaycloud.system.model.dto.TripLineDTO$UpdateDTO

名称	类型	必填	说明	示例
name	string	否	航线名称
description	string	否	描述
images	string	否	图片
cruiseId	string	否	游船ID
code	string	否	编号
status	string	否	状态	"ACTIVE"
departureDate	string(date)	否	出发日期	"2021-10-11"
checkIn	LocalTime	否
cutOff	LocalTime	否
days	integer(int32)	否	航行天数
theme	string	否	航线主题
title	string	否	标题
remark	string	否	备注
voyageId	string	否	航次ID
hot	boolean	否	？？？
enable	boolean	否	？？？
settleable	boolean	否	？？？
settled	boolean	否	？？？
deleted	boolean	否	是否删除
line	string	否	明细对象
cruise	string	否	邮轮详情
routes	string	否	航线行程
weather	string	否	天气

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResTripLine	否

PUT

/api/trip-line/close/{id}

航线管理关闭航程 OperationId: closeTripLine

调用方法

PUT /api/trip-line/close/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	49

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResTripLine	否

PUT

/api/tag/updateGroup/{groupId}

标签管理编辑标签组信息 OperationId: updateGroup

调用方法

PUT /api/tag/updateGroup/{groupId}

参数

名称	位置	必填	类型	说明	示例
groupId	path	是	integer(int64)	标签组ID	0

请求体

Content-Type: application/json 必填: 是 类型: TagGroupDTO$UpdateDTO com.leadwaycloud.system.model.dto.TagGroupDTO$UpdateDTO

名称	类型	必填	说明	示例
name	string	否	组名称
description	string	否	描述

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/tag/update/{id}

标签管理编辑标签 OperationId: update_2

调用方法

PUT /api/tag/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	标签ID	0

请求体

Content-Type: application/json 必填: 是 类型: TagDTO$UpdateDTO com.leadwaycloud.system.model.dto.TagDTO$UpdateDTO

名称	类型	必填	说明
name	string	否	名称
status	string	否	状态(ACTIVE:可用,DEACTIVATE:停用)
groupId	integer(int64)	否	组ID
description	string	否	描述

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/sys/property/updateList

系统公用属性批量编辑系统属性 OperationId: updateList

调用方法

PUT /api/sys/property/updateList

参数

无

请求体

Content-Type: application/json 必填: 是 类型: SysPropertyDTO$UpdateDTO[] com.leadwaycloud.system.model.dto.SysPropertyDTO$UpdateDTO

名称	类型	必填	说明	示例
(array)	SysPropertyDTO$UpdateDTO[]

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/sys/property/update/{id}

系统公用属性编辑系统属性 OperationId: update_3

调用方法

PUT /api/sys/property/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	属性ID	0

请求体

Content-Type: application/json 必填: 是 类型: SysPropertyDTO$UpdateDTO com.leadwaycloud.system.model.dto.SysPropertyDTO$UpdateDTO

名称	类型	必填	说明
id	integer(int64)	否	ID
name	string	否	名称
group	string	否	分组
active	boolean	否	是否可用
val	string	否	属性值
description	string	否	描述
parentId	integer(int64)	否	上一级
sequence	integer(int32)	否	排序
hide	boolean	否	是否隐藏

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/shift-reconciliation-config/shell/update/{id}

班结配置-壳牌编辑班结配置 OperationId: update_4

调用方法

PUT /api/shift-reconciliation-config/shell/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	班结配置ID

请求体

Content-Type: application/json 必填: 是 类型: string

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/role/update/{id}

角色管理编辑角色 OperationId: update_5

调用方法

PUT /api/role/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID

请求体

Content-Type: application/json 必填: 是 类型: RoleDTO$UpdateDTO com.leadwaycloud.system.model.dto.RoleDTO$UpdateDTO

名称	类型	必填	说明	示例
name	string	否	角色名称	"运维组"
description	string	否	描述	"公司ERP系统维护人员"
functionIdList	integer(int64)[]	否	功能ID集合
template	boolean	否	是否是模板	true
companyType	string	否	公司类型	"STORE"
appId	integer(int64)	否	sys_app.id

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRole	否

PUT

/api/role/assignUser/{id}

角色管理分配用户 OperationId: assignPermissions_1

调用方法

PUT /api/role/assignUser/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID

请求体

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

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

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRole	否

PUT

/api/reportGroup/update/{id}

报表分类编辑报表分类 OperationId: update_6

调用方法

PUT /api/reportGroup/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	报表分类ID

请求体

Content-Type: application/json 必填: 是 类型: SysReportGroupDTO$UpdateDTO com.leadwaycloud.system.model.dto.SysReportGroupDTO$UpdateDTO

名称	类型	必填	说明	示例
name	string	否	名称
status	string	否	状态

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysReportGroup	否

PUT

/api/reportDashboard/update/{id}

仪表板配置编辑仪表板配置 OperationId: update_7

调用方法

PUT /api/reportDashboard/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	仪表板配置ID

请求体

Content-Type: application/json 必填: 是 类型: ReportDashboardDTO$UpdateDTO com.leadwaycloud.system.model.dto.ReportDashboardDTO$UpdateDTO

名称	类型	必填	说明	示例
modelId	integer(int64)	否	模型ID	608486975133453
userId	integer(int64)	否	用户ID	618708628295069
companyId	integer(int64)	否	公司ID	574533689957252
merchantId	integer(int64)	否	商户号ID	574533689957248
reportDashboardLayoutDTOList	SysReportDashboardLayoutDTO[]	否	仪表盘自定义布局配置集合
delReportDashboardLayoutList	integer(int64)[]	否	删除明细集合

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysReportDashboard	否

PUT

/api/report/bindReportRole

报表配置编辑报表绑定用户或者角色 OperationId: bindReportRole

调用方法

PUT /api/report/bindReportRole

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ReportDTO$BindReportRoleDTO com.leadwaycloud.system.model.dto.ReportDTO$BindReportRoleDTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	574533689957252
reportId	integer(int64)	是	报表ID	628765092806207
userIdList	integer(int64)[]	否	用户ID集合
roleIdList	integer(int64)[]	否	角色ID集合

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/report/bindReportGroup

报表配置绑定报表分类 OperationId: bindReportGroup

调用方法

PUT /api/report/bindReportGroup

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ReportDTO$BindReportGroupDTO com.leadwaycloud.system.model.dto.ReportDTO$BindReportGroupDTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
reportId	integer(int64)	是	报表ID
reportGroupIdList	integer(int64)[]	否	报表分类ID集合

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/reasonCode/update/{id}

原因码管理编辑原因码 OperationId: update_8

调用方法

PUT /api/reasonCode/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	原因码ID	0

请求体

Content-Type: application/json 必填: 是 类型: ReasonCodeDTO$UpdateDTO com.leadwaycloud.system.model.dto.ReasonCodeDTO$UpdateDTO

名称	类型	必填	说明
code	string	否	编号
name	string	否	名称
typeId	integer(int64)	否	类型ID
externalCode	string	否	外部编号

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/rating/update

评价管理编辑评价 OperationId: update_9

调用方法

PUT /api/rating/update

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ResRatingDTO$UpdateDTO com.leadwaycloud.system.model.dto.res.ResRatingDTO$UpdateDTO

名称	类型	必填	说明
id	integer(int64)	否	id
ratingTplId	integer(int64)	否	模版id
originType	string	否	源订单类型
originId	integer(int64)	否	源订单id
totalPenalty	number(double)	否	总扣分
status	string	否	状态
resIssuesRatingLineList	ResRatingLineDTO[]	否	修改问题评价明细集合
delResIssuesRatingLineList	integer(int64)[]	否	删除问题评价明细集合

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/rating/topic/update

评价题库管理编辑评价题库 OperationId: update_10

调用方法

PUT /api/rating/topic/update

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ResRatingTopicDTO$UpdateDTO com.leadwaycloud.system.model.dto.res.ResRatingTopicDTO$UpdateDTO

名称	类型	必填	说明
id	integer(int64)	否	id
ratingCategoryId	integer(int64)	否	评价分类id
content	string	否	内容
totalScore	integer(int64)	否	总分
merchantId	integer(int64)	否	商户id
status	string	否	状态

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/rating/topic/cancel/{id}

评价题库管理删除评价题库 OperationId: cancel

调用方法

PUT /api/rating/topic/cancel/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	题库ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/rating/template/update

评价模版管理编辑评价模版 OperationId: update_11

调用方法

PUT /api/rating/template/update

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ResRatingTemplateDTO$UpdateDTO com.leadwaycloud.system.model.dto.res.ResRatingTemplateDTO$UpdateDTO

名称	类型	必填	说明
id	integer(int64)	是	id
type	string	否	模版类型(合同/其他)
totalPenalty	number(double)	否	总扣分
note	string	否	备注
status	string	否	问题内容
name	string	否	名称
ratingTopicIdList	integer(int64)[]	否	题库ID集合

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/rating/template/cancel/{id}

评价模版管理删除评价模版 OperationId: cancel_1

调用方法

PUT /api/rating/template/cancel/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	问题评价模版ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/rating/category/update

评价分类管理编辑评价分类 OperationId: update_12

调用方法

PUT /api/rating/category/update

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ResRatingCategoryDTO$UpdateDTO com.leadwaycloud.system.model.dto.res.ResRatingCategoryDTO$UpdateDTO

名称	类型	必填	说明
id	integer(int64)	否	id
name	string	否	名称
code	string	否	编号
parentId	integer(int64)	否	上一级id
merchantId	integer(int64)	否	商户id
idChain	string	否	完整的组织结构
status	string	否	状态
ratingUserId	integer(int64)	否	评价人ID

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/rating/category/cancel/{id}

评价分类管理删除评价分类 OperationId: cancel_2

调用方法

PUT /api/rating/category/cancel/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	分类ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/rating/cancel/{id}

评价管理删除评价 OperationId: cancel_3

调用方法

PUT /api/rating/cancel/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	评价ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/loginConfig/update/{id}

用户登录配置编辑登录配置 OperationId: update_13

调用方法

PUT /api/loginConfig/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	配置ID	0

请求体

Content-Type: application/json 必填: 是 类型: LoginConfigDTO$UpdateDTO com.leadwaycloud.system.model.dto.LoginConfigDTO$UpdateDTO

名称	类型	必填	说明	示例
enableDualVerify	boolean	否	是否开启双重验证（密码+验证码）
enableEmailVerify	boolean	否	是否开启邮件验证
enableShortMessageVerify	boolean	否	是否开启短信验证
loginErrorCountCheck	boolean	否	登录错误次数校验
allowErrorCount	integer(int32)	否	允许错误次数
lockTime	integer(int32)	否	锁定时间
lockTimeUom	string	否	锁定时间单位（分、时、天）	"DAY"

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResLoginConfig	否

PUT

/api/login/forgotPassword

用户登录忘记密码 OperationId: forgotPassword

调用方法

PUT /api/login/forgotPassword

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ForgotPasswordDTO com.leadwaycloud.system.model.dto.login.ForgotPasswordDTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
userName	string	否	用户名
mobilePhone	string	否	手机号
captcha	string	是	验证码
password	string	是	需要修改的密码

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/login/accountActivation

用户登录账号激活 OperationId: accountActivation

调用方法

PUT /api/login/accountActivation

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AccountActivationDTO com.leadwaycloud.system.model.dto.login.AccountActivationDTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
userName	string	否	用户名
captcha	string	是	验证码
password	string	是	需要初始化的密码

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/log/clearConfig/update/{id}

日志管理编辑清理配置 OperationId: updateClearConfig

调用方法

PUT /api/log/clearConfig/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

Content-Type: application/json 必填: 是 类型: LogClearConfigDTO$UpdateDTO com.leadwaycloud.system.model.dto.LogClearConfigDTO$UpdateDTO

名称	类型	必填	说明	示例
reserveTime	integer(int32)	否	保留时间（单位：月）	1
status	string	否	状态（ACTIVE, DEACTIVATE）
host	string	否	IP地址

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/lang-translation/translation/update/{id}

语言于翻译字典更新商户翻译字典 OperationId: updateTranslation

调用方法

PUT /api/lang-translation/translation/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)

请求体

Content-Type: application/json 必填: 是 类型: TranslationDTO$UpdateDTO com.leadwaycloud.system.model.dto.TranslationDTO$UpdateDTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户
translationId	integer(int64)	是	语言
value	string	是	翻译

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResTranslation	否

PUT

/api/lang-translation/lang/update/{id}

语言于翻译字典商户自定义语言设置 OperationId: updateLang

调用方法

PUT /api/lang-translation/lang/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

Content-Type: application/json 必填: 是 类型: LangDTO$UpdateDTO com.leadwaycloud.system.model.dto.LangDTO$UpdateDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户
langId	integer(int64)	是	语言
direction	string	是	排序方向	"ltr"
thousandsSep	string	是	千分位符号
translatable	boolean	是	是否有翻译	false
dateFormat	string	是	日期格式	"%Y年%m月%d日"
timeFormat	string	是	时间格式	"%H时%M分%S秒"
decimalPoint	string	是	小数点符号	"."
weekStart	integer(int32)	是	每周开始天

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResLang	否

PUT

/api/issues/update

问题信息编辑问题 OperationId: update_14

调用方法

PUT /api/issues/update

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ResIssuesDTO$UpdateDTO com.leadwaycloud.system.model.dto.res.ResIssuesDTO$UpdateDTO

名称	类型	必填	说明
id	integer(int64)	是	id
title	string	否	问题标题
content	string	否	问题内容
originId	integer(int64)	是	业务ID
originType	string	否	合同/其他
status	string	否	状态
startDate	string(date)	否	开始日期
endDate	string(date)	否	结束日期
assignPersonIdList	integer(int64)[]	否	指派人ID集合
priority	string	否	优先级
associatedTagDTO	TagDTO$AssociatedTagDTO	否
model	string	否	类型
file	integer(int64)	否	附件
departmentIdList	integer(int64)[]	否	部门集合

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/issues/comment/update

问题评论管理编辑问题评论 OperationId: update_15

调用方法

PUT /api/issues/comment/update

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ResIssuesCommentDTO$UpdateDTO com.leadwaycloud.system.model.dto.res.ResIssuesCommentDTO$UpdateDTO

名称	类型	必填	说明
id	integer(int64)	是	评论ID
content	string	是	问题内容
status	string	是	问题内容
operatorId	integer(int64)	否	操作人ID

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/issues/comment/cancel/{id}

问题评论管理删除问题评论 OperationId: cancel_4

调用方法

PUT /api/issues/comment/cancel/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	问题ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/issues/cancel/{id}

问题信息取消问题 OperationId: cancel_5

调用方法

PUT /api/issues/cancel/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	问题ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/idaasConfig/updateConfig

IDaaS配置管理编辑IDaaS配置 OperationId: updateConfig

调用方法

PUT /api/idaasConfig/updateConfig

参数

无

请求体

Content-Type: application/json 必填: 是 类型: IdaasConfigDTO com.leadwaycloud.system.model.dto.idaas.IdaasConfigDTO

名称	类型	必填	说明
id	integer(int64)	否	ID
appId	string	是	应用ID
jwkUrl	string	是	JWK URL地址
jwkJson	string	否	JWK JSON内容(可选,用于离线验证)
encryptKey	string	否	加密密钥
active	boolean	否	是否可用

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResIdaasConfig	否

PUT

/api/externalApplication/update-mapping

外部应用管理编辑数据映射关系 OperationId: updateMapping

调用方法

PUT /api/externalApplication/update-mapping

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ExternalDataMappingDTO$BatchUpdateDTO com.leadwaycloud.system.model.dto.ExternalDataMappingDTO$BatchUpdateDTO

名称	类型	必填	说明
addDTOList	ExternalDataMappingDTO$AddDTO[]	否	添加映射对象集合
updateDTOList	ExternalDataMappingDTO$UpdateDTO[]	否	编辑映射对象集合
delIdList	integer(int64)[]	否	删除映射对象ID集合

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/externalApplication/update-config/{id}

外部应用管理编辑应用基础配置 OperationId: updateConfig_1

调用方法

PUT /api/externalApplication/update-config/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	应用配置ID	0

请求体

Content-Type: application/json 必填: 是 类型: ExternalAppConfigDTO$UpdateDTO com.leadwaycloud.system.model.dto.ExternalAppConfigDTO$UpdateDTO

名称	类型	必填	说明
businessDate	string(date)	否	营业日
shiftNo	integer(int32)	否	班次
insertCoins	string	否	投币
cashOut	string	否	现金出
customersLeaveWithoutPaying	string	否	跑单
oilGunTest	string	否	油枪测试
syncNonOilStock	boolean	否	是否同步非油库存
isAutoShelf	boolean	否	是否自动上架

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/endOfDayConfig/shell/update/{id}

日结配置-壳牌编辑日结配置 OperationId: update_16

调用方法

PUT /api/endOfDayConfig/shell/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	日结配置ID

请求体

Content-Type: application/json 必填: 是 类型: EndOfDayConfigDTO$UpdateDTO com.leadwaycloud.system.shell.model.dto.EndOfDayConfigDTO$UpdateDTO

名称	类型	必填	说明
startBusinessDate	string(date)	是	初始营业日
autoEndOfDay	boolean	否	开启自动日结
dryNegativeStockCheck	boolean	否	开启非油负库存校验
fuelInventorySummary	boolean	否	开启油品帐存差异校验
fuelInventorySummaryConfigDTOList	EndOfDayConfigDTO$ResFuelInventorySummaryConfigDTO[]	否	油品帐存差异配置明细
delFuelInventorySummaryConfigIdList	integer(int64)[]	否	删除油品帐存差异配置明细ID

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/email/template/update/{id}

邮件模板管理编辑 OperationId: update_17

调用方法

PUT /api/email/template/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID

请求体

Content-Type: application/json 必填: 是 类型: EmailTemplateDTO$UpdateDTO com.leadwaycloud.system.model.dto.EmailTemplateDTO$UpdateDTO

名称	类型	必填	说明
title	string	否	标题
status	string	否	状态
content	string	否	内容
ccRole	string	否	抄送角色
ccUser	string	否	抄送用户ID集合
addresseeUser	string	否	收件用户ID集合
notifySupplier	boolean	否	通知供应商

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/dynamic-task/update/{id}

动态任务管理编辑任务 OperationId: updateDynamicTask

调用方法

PUT /api/dynamic-task/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	任务ID	1

请求体

Content-Type: application/json 必填: 是 类型: DynamicTaskDTO com.leadwaycloud.system.model.dto.DynamicTaskDTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
merchantId	integer(int64)	是	商户ID	1
name	string	是	名称
code	string	是	代码
cron	string	是	cron表达式
issuedSystem	string	是	推送系统	"1"
issuedType	string	是	推送类型	"1"
isActive	boolean	是	是否启用
lastTime	string(date-time)	否	最后推送时间
taskConfig	string	是	任务配置

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResDynamicTask	否

PUT

/api/dynamic-task/last-time/{id}/{lastTime}

动态任务管理更新任务执行时间 OperationId: updateTaskLastTime

调用方法

PUT /api/dynamic-task/last-time/{id}/{lastTime}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	任务ID	1
lastTime	path	是	string	执行时间	"2023-06-05 12:12:45.123"

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResDynamicTask	否

PUT

/api/dynamic-task/action/{id}/{actionType}

动态任务管理停止/恢复指定任务 OperationId: pauseDynamicTask

调用方法

PUT /api/dynamic-task/action/{id}/{actionType}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	任务ID	1
actionType	path	是	string	任务操作(pause\|resume)	"pause"

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResDynamicTask	否

PUT

/api/currency/update/{id}

货币信息修改货币接口 OperationId: update_18

调用方法

PUT /api/currency/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

Content-Type: application/json 必填: 是 类型: CurrencyDTO$UpdateDTO com.leadwaycloud.system.model.dto.CurrencyDTO$UpdateDTO

名称	类型	必填	说明	示例
code	string	否	编号	"CNY"
name	string	否	名称	"人民币"
symbol	string	否	符号	"¥"
image	string	否	图片
rounding	integer(int32)	否	四舍五入精度
active	boolean	否	是否可用	true
calcRate	boolean	否	是否计算汇率	true
calcRateUnit	number(double)	否	汇率计算单位
roundingType	string	否	金额进舍规则:0=全部进位,1=全部舍位,2=四舍五入	"2"

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysCurrency	否

PUT

/api/currency/synchronize/currency-rate

货币信息同步货币汇率接口 OperationId: synchronizeCurrencyRate

调用方法

PUT /api/currency/synchronize/currency-rate

参数

无

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/contact/update/{id}

联系地址管理编辑联系地址 OperationId: update_19

调用方法

PUT /api/contact/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

Content-Type: application/json 必填: 是 类型: ContactDTO$UpdateDTO com.leadwaycloud.system.model.dto.ContactDTO$UpdateDTO

名称	类型	必填	说明	示例
countryId	integer(int64)	否	国家ID	1
stateId	integer(int64)	否	省、直辖市ID	1
cityId	integer(int64)	否	城市ID	1
areaId	integer(int64)	否	区、县ID	1
streetId	integer(int64)	否	街道ID	1
address	string	否	详细地址	"1"
postcode	string	否	邮编	"1"
phone	string	否	电话	"1"
fax	string	否	传真	"1"
email	string	否	邮箱	"邮箱"
mobile	string	否	手机	"1"

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResContact	否

PUT

/api/companyGroup/update/{id}

公司组管理编辑公司组 OperationId: update_20

调用方法

PUT /api/companyGroup/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	公司组ID

请求体

Content-Type: application/json 必填: 是 类型: CompanyGroupDTO$UpdateDTO com.leadwaycloud.system.model.dto.CompanyGroupDTO$UpdateDTO

名称	类型	必填	说明
status	string	否	状态
name	string	否	名称
description	string	否	描述
type	string	否	类型

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/company/update/{id}

公司管理编辑公司 OperationId: update_21

调用方法

PUT /api/company/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

Content-Type: application/json 必填: 是 类型: CompanyDTO$UpdateDTO com.leadwaycloud.system.model.dto.CompanyDTO$UpdateDTO

名称	类型	必填	说明	示例
name	string	否	公司名称	"立威云"
image	string	否	公司LOGO	"xxx.logo"
slogan	string	否	公司标语	"111"
status	string	否	状态	"IN_OPERATION"
otherCode	string	否	其他编号	"AAAA-01"
updateContactDTO	ContactDTO$UpdateDTO	否
updateFinanceInvoiceTitleDTO	FinanceInvoiceTitleDTO$UpdateDTO	否

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResCompany	否

PUT

/api/company/assignAdministrativeUsers/{id}

公司管理分配可管理公司用户 OperationId: assignAdministrativeUsers

调用方法

PUT /api/company/assignAdministrativeUsers/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

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

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

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResCompany	否

PUT

/api/calendar/sysUpdate

日历管理更新系统日历 OperationId: sysUpdate

调用方法

PUT /api/calendar/sysUpdate

参数

名称	位置	必填	类型	说明	示例
year	query	否	integer(int32)	按年份更新	2024

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/calendar/resUpdate

日历管理更新商户日志 OperationId: resUpdate

调用方法

PUT /api/calendar/resUpdate

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ResCalendarDTO$UpdateDTO[] com.leadwaycloud.system.model.dto.ResCalendarDTO$UpdateDTO

名称	类型	必填	说明	示例
(array)	ResCalendarDTO$UpdateDTO[]

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/application/updateKey/{id}

应用管理公私密钥更新 OperationId: updateKey

调用方法

PUT /api/application/updateKey/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResApplication	否

PUT

/api/application/update/{id}

应用管理编辑 OperationId: update_22

调用方法

PUT /api/application/update/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	应用ID	1

请求体

Content-Type: application/json 必填: 是 类型: string

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

PUT

/api/application/refreshToken/{id}

应用管理刷新应用token OperationId: refreshToken

调用方法

PUT /api/application/refreshToken/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	应用ID	1

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/userPerson/updateInfo

用户个人管理用户个人信息修改 OperationId: personalCenterUpdate

调用方法

POST /api/userPerson/updateInfo

参数

无

请求体

Content-Type: application/json 必填: 是 类型: UserPersonalCenterDTO com.leadwaycloud.system.model.dto.UserPersonalCenterDTO

名称	类型	必填	说明
name	string	是	用户名称
language	string	是	系统语言
image	string	是	图片

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/userMall/unfreezeUser

商城用户管理冻结用户解除 OperationId: unfreezeUser

调用方法

POST /api/userMall/unfreezeUser

参数

名称	位置	必填	类型	说明	示例
userId	query	是	integer(int64)	待解除冻结用户ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/userMall/unbindUser

商城用户管理解绑用户 OperationId: unbindUser

调用方法

POST /api/userMall/unbindUser

参数

名称	位置	必填	类型	说明	示例
userId	query	是	integer(int64)	待解绑用户ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/userMall/transferMasterUser

商城用户管理转移主用户 OperationId: transferMasterUser

调用方法

POST /api/userMall/transferMasterUser

参数

名称	位置	必填	类型	说明	示例
userId	query	是	integer(int64)	主账号转移到的用户ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/userMall/registerMallUser

商城用户管理注册商城用户 OperationId: registerMallUser

调用方法

POST /api/userMall/registerMallUser

参数

无

请求体

Content-Type: application/json 必填: 是 类型: RegisterMallUserDTO com.leadwaycloud.system.model.dto.register.RegisterMallUserDTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
customerName	string	是	客户名称
contactPersonName	string	是	联系人名称
userName	string	是	用户名
nickName	string	是	昵称
mobilePhone	string	是	手机号
captcha	string	是	验证码

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/userMall/joinCustomer

商城用户管理加入企业 OperationId: joinCustomer

调用方法

POST /api/userMall/joinCustomer

参数

名称	位置	必填	类型	说明	示例
customerName	query	是	string	待加入企业名称
contactPersonName	query	是	string	联系人名称

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/userMall/joinCustomerReject

商城用户管理审核用户加入企业-驳回 OperationId: joinCustomerReject

调用方法

POST /api/userMall/joinCustomerReject

参数

名称	位置	必填	类型	说明	示例
userId	query	是	integer(int64)	待审核用户ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/userMall/joinCustomerApprove

商城用户管理审核用户加入企业-同意 OperationId: joinCustomerApprove

调用方法

POST /api/userMall/joinCustomerApprove

参数

名称	位置	必填	类型	说明	示例
userId	query	是	integer(int64)	待审核用户ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/userMall/freezeUser

商城用户管理冻结用户 OperationId: freezeUser

调用方法

POST /api/userMall/freezeUser

参数

名称	位置	必填	类型	说明	示例
userId	query	是	integer(int64)	待冻结用户ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/userMall/deleteUser

商城用户管理注销用户 OperationId: deleteUser

调用方法

POST /api/userMall/deleteUser

参数

名称	位置	必填	类型	说明	示例
captcha	query	是	string	验证码

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/userCaptcha/verificationGraphicCaptcha

用户验证码检查用户图形验证码 OperationId: verificationGraphicCaptcha

调用方法

POST /api/userCaptcha/verificationGraphicCaptcha

参数

名称	位置	必填	类型	说明
captchaType	query	是	string	验证码类型(由前端控制)
businessKey	query	是	string	业务值(前端传UUID，后续校验也需要根据这个UUID进行校验)
graphicCaptcha	query	是	string	图形验证码

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/userCaptcha/verificationCaptcha

用户验证码检查用户验证码 OperationId: verificationCaptcha

调用方法

POST /api/userCaptcha/verificationCaptcha

参数

名称	位置	必填	类型	说明
captchaType	query	是	string	用户验证码业务类型【 FORGET_PASSWORD : LOGIN : ACCOUNT_ACTIVATION : ACCOUNT_DELETE : UPDATE_PASSWORD : MALL_CUSTOMER_CONTACT_REGISTER : UPDATE_MOBILE_PHONE_OLD : UPDATE_MOBILE_PHONE_NEW : UPDATE_EMAIL_OLD : UPDATE_EMAIL_NEW : TWO_FACTOR_AUTHENTICATION : 】
businessKey	query	是	string	业务值(手机号,用户ID,邮箱)
captcha	query	是	string	验证码

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/userCaptcha/sendGraphicCaptcha

用户验证码发送用户图形验证码 OperationId: sendGraphicCaptcha

调用方法

POST /api/userCaptcha/sendGraphicCaptcha

参数

名称	位置	必填	类型	说明
captchaType	query	是	string	验证码类型(由前端控制)
businessKey	query	是	string	业务值(前端传UUID，后续校验也需要根据这个UUID进行校验)
width	query	否	integer(int32)	图形宽度
height	query	否	integer(int32)	图形高度

请求体

无

响应

状态码: 200 说明: OK

无

POST

/api/userCaptcha/sendCaptcha

用户验证码发送用户验证码 OperationId: sendCaptcha

调用方法

POST /api/userCaptcha/sendCaptcha

参数

名称	位置	必填	类型	说明
captchaType	query	是	string	用户验证码业务类型【 FORGET_PASSWORD : LOGIN : ACCOUNT_ACTIVATION : ACCOUNT_DELETE : UPDATE_PASSWORD : MALL_CUSTOMER_CONTACT_REGISTER : UPDATE_MOBILE_PHONE_OLD : UPDATE_MOBILE_PHONE_NEW : UPDATE_EMAIL_OLD : UPDATE_EMAIL_NEW : TWO_FACTOR_AUTHENTICATION : 】
merchantId	query	是	integer(int64)	商户号ID
userId	query	否	integer(int64)	用户ID(验证用户)
userName	query	否	string	用户名(验证用户)
mobilePhone	query	否	string	手机号(验证用户\|\|没账户的情况下发送SMS)
email	query	否	string	邮箱(验证用户\|\|没账户的情况下发送邮件)
captchaSendType	query	是	string	验证码发送类型【 SMS : EMAIL : 】
validTime	query	否	integer(int32)	验证码有效期，单位:秒
smsTemplateCode	query	否	string	短信模版编号，默认 CAPTCHA

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/user/shell/exportUserRole

用户管理-壳牌导出用户角色列表 OperationId: exportUserRole

调用方法

POST /api/user/shell/exportUserRole

参数

无

请求体

Content-Type: application/json 必填: 是 类型: Object com.leadwaycloud.system.plug.poi.model.dto.ExportDTOJava.lang.Object

名称	类型	必填	说明
reportColumnList	ReportColumnDTO[]	是	需导出参数集合
queryDTO	object	是	搜索条件对象DTO
fileName	string	是	导出文件名

响应

状态码: 200 说明: OK

无

POST

/api/user/registerPartnerUser/{partnerId}

用户管理注册Partner关系用户 OperationId: registerPartnerUser

调用方法

POST /api/user/registerPartnerUser/{partnerId}

参数

名称	位置	必填	类型	说明	示例
partnerId	path	是	integer(int64)	CRM关系ID

请求体

Content-Type: application/json 必填: 是 类型: UserDTO$AddDTO com.leadwaycloud.system.model.dto.UserDTO$AddDTO

名称	类型	必填	说明	示例
email	string	是	邮箱
name	string	否	用户名称	"hyj"
language	string	是	系统语言	"zh_CN"
image	string	否	图片	"xxxxx"
companyId	integer(int64)	是	公司ID	1
merchantId	integer(int64)	是	商户ID	1
userName	string	是	账号
password	string	否	默认密码
status	string	否	状态(INACTIVATED:未激活；ACTIVE:激活)
sign	string	否	签名
forceUpdatePassword	boolean	否	是否强制修改密码
mobilePhone	string	否	手机号	"131"
partnerId	integer(int64)	否	CRM关系ID
allowLoginChannel	boolean	否	允许登陆渠道(ERP:ERP_BACKEND,电商平台:ECOMMERCE_PLATFORM,供应商平台:SUPPLIER_PLATFORM)。如果有多个用,逗号隔开
registerChannel	boolean	否	注册渠道(ERP:ERP_BACKEND,电商前台:ECOMMERCE_PLATFORM,IDaaS平台:IDAAS)
idaasId	string	否	idaas唯一ID
userAuditStatus	string	否	用户审核状态
externalCode	string	否	外部编号

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResUser	否

POST

/api/user/add

用户管理添加用户 OperationId: add

调用方法

POST /api/user/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: UserDTO$AddDTO com.leadwaycloud.system.model.dto.UserDTO$AddDTO

名称	类型	必填	说明	示例
email	string	是	邮箱
name	string	否	用户名称	"hyj"
language	string	是	系统语言	"zh_CN"
image	string	否	图片	"xxxxx"
companyId	integer(int64)	是	公司ID	1
merchantId	integer(int64)	是	商户ID	1
userName	string	是	账号
password	string	否	默认密码
status	string	否	状态(INACTIVATED:未激活；ACTIVE:激活)
sign	string	否	签名
forceUpdatePassword	boolean	否	是否强制修改密码
mobilePhone	string	否	手机号	"131"
partnerId	integer(int64)	否	CRM关系ID
allowLoginChannel	boolean	否	允许登陆渠道(ERP:ERP_BACKEND,电商平台:ECOMMERCE_PLATFORM,供应商平台:SUPPLIER_PLATFORM)。如果有多个用,逗号隔开
registerChannel	boolean	否	注册渠道(ERP:ERP_BACKEND,电商前台:ECOMMERCE_PLATFORM,IDaaS平台:IDAAS)
idaasId	string	否	idaas唯一ID
userAuditStatus	string	否	用户审核状态
externalCode	string	否	外部编号

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResUser	否

POST

/api/uom/importUom/{merchantId}

计量单位信息导入系统单位到商户 OperationId: importUom

调用方法

POST /api/uom/importUom/{merchantId}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)	商户ID	1

请求体

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

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

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/uom/export

计量单位信息导出计量单位 OperationId: exportUom

调用方法

POST /api/uom/export

参数

无

请求体

Content-Type: application/json 必填: 是 类型: SystemUomDTO$QueryDTO com.leadwaycloud.system.plug.poi.model.dto.ExportDTOCom.leadwaycloud.system.model.dto.SystemUomDTO$QueryDTO

名称	类型	必填	说明
reportColumnList	ReportColumnDTO[]	是	需导出参数集合
queryDTO	SystemUomDTO$QueryDTO	是
fileName	string	是	导出文件名

响应

状态码: 200 说明: OK

无

POST

/api/uom/add

计量单位信息添加计量单位接口 OperationId: add_1

调用方法

POST /api/uom/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: SystemUomDTO$AddDTO com.leadwaycloud.system.model.dto.SystemUomDTO$AddDTO

名称	类型	必填	说明	示例
code	string	是	编号	"1"
name	string	是	名称	"公斤"
symbol	string	是	符号	"kg"
ratio	number(double)	否	换算率
shortName	string	否	简称
merchantId	integer(int64)	是	商户ID
isoShortName	string	否	ISO名称

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysUom	否

POST

/api/trip-line/sync/{merchantId}

航线管理同步航线数据 OperationId: syncTripLine

调用方法

POST /api/trip-line/sync/{merchantId}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)

请求体

Content-Type: application/json 必填: 是 类型: SyncTripLineDTO[] com.leadwaycloud.system.model.dto.SyncTripLineDTO

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

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/trip-line/add

航线管理新增航线数据 OperationId: addTripLine

调用方法

POST /api/trip-line/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: TripLineDTO$AddDTO com.leadwaycloud.system.model.dto.TripLineDTO$AddDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID
name	string	是	航线名称
description	string	否	描述
images	string	否	图片
cruiseId	string	是	游船ID
code	string	是	编号
departureDate	string(date)	是	出发日期	"2021-10-11"
checkIn	LocalTime	是
cutOff	LocalTime	是
days	integer(int32)	是	航行天数
theme	string	否	航线主题
title	string	否	标题
remark	string	否	备注
voyageId	string	否	航次ID
hot	boolean	否	？？？
enable	boolean	否	？？？
settleable	boolean	否	？？？
settled	boolean	否	？？？
deleted	boolean	否	是否删除
line	string	否	明细对象
cruise	string	否	邮轮详情
routes	string	否	航线行程
weather	string	否	天气

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResTripLine	否

POST

/api/tag/associatedTag

标签管理关联标签 OperationId: associatedTag

调用方法

POST /api/tag/associatedTag

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AssociatedTagDTO com.leadwaycloud.system.model.dto.AssociatedTagDTO

名称	类型	必填	说明	示例
tagIdList	integer(int64)[]	否	标签ID
associateType	string	是	关联类型
associateId	integer(int64)	是	关联ID	1
disassociateTagIdList	integer(int64)[]	否	取消关联标签ID

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/tag/add

标签管理添加标签 OperationId: add_2

调用方法

POST /api/tag/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: TagDTO$AddDTO com.leadwaycloud.system.model.dto.TagDTO$AddDTO

名称	类型	必填	说明	示例
name	string	是	标签名称
merchantId	integer(int64)	是	商户ID	1
groupId	integer(int64)	否	组ID	1
type	string	否	类型	"1"
description	string	否	描述

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	integer(int64)	否	返回数据

POST

/api/tag/addGroup

标签管理添加标签组信息 OperationId: addGroup

调用方法

POST /api/tag/addGroup

参数

无

请求体

Content-Type: application/json 必填: 是 类型: TagGroupDTO$AddDTO com.leadwaycloud.system.model.dto.TagGroupDTO$AddDTO

名称	类型	必填	说明	示例
name	string	是	组名称
merchantId	integer(int64)	是	商户ID	1
description	string	否	描述
groupId	integer(int64)	否	组ID

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	integer(int64)	否	返回数据

POST

/api/sys/property/add

系统公用属性添加系统属性 OperationId: add_3

调用方法

POST /api/sys/property/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: SysPropertyDTO$AddDTO[] com.leadwaycloud.system.model.dto.SysPropertyDTO$AddDTO

名称	类型	必填	说明	示例
(array)	SysPropertyDTO$AddDTO[]

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysProperty[]	否	返回数据

POST

/api/shift-reconciliation-config/shell/synchronization/{companyId}

班结配置-壳牌同步班结配置 OperationId: synchronization

调用方法

POST /api/shift-reconciliation-config/shell/synchronization/{companyId}

参数

名称	位置	必填	类型	说明	示例
companyId	path	是	integer(int64)	配置所属公司Id

请求体

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

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

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/shift-reconciliation-config/shell/add

班结配置-壳牌添加班结配置 OperationId: add_4

调用方法

POST /api/shift-reconciliation-config/shell/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ShiftReconciliationConfigDTO$AddDTO com.leadwaycloud.system.shell.model.dto.ShiftReconciliationConfigDTO$AddDTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
companyId	integer(int64)	是	公司ID
config	string	是	配置

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	integer(int64)	否	返回数据

POST

/api/role/sync/{id}

角色管理角色同步 OperationId: sync

调用方法

POST /api/role/sync/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	角色模板ID

请求体

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

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

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/role/shell/exportRoleFunction

角色管理-壳牌导出角色权限功能表 OperationId: exportRoleFunction

调用方法

POST /api/role/shell/exportRoleFunction

参数

无

请求体

Content-Type: application/json 必填: 是 类型: Object com.leadwaycloud.system.plug.poi.model.dto.ExportDTOJava.lang.Object

名称	类型	必填	说明
reportColumnList	ReportColumnDTO[]	是	需导出参数集合
queryDTO	object	是	搜索条件对象DTO
fileName	string	是	导出文件名

响应

状态码: 200 说明: OK

无

POST

/api/role/issued/{id}

角色管理下发角色 OperationId: issued

调用方法

POST /api/role/issued/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	角色模板ID

请求体

Content-Type: application/json 必填: 是 类型: ExtendsTemplateRoleDTO[] com.leadwaycloud.system.model.dto.ExtendsTemplateRoleDTO

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

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/role/add

角色管理添加角色 OperationId: add_5

调用方法

POST /api/role/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: RoleDTO$AddDTO com.leadwaycloud.system.model.dto.RoleDTO$AddDTO

名称	类型	必填	说明	示例
name	string	是	角色名称	"运维组"
description	string	否	描述	"公司ERP系统维护人员"
companyId	integer(int64)	是	公司ID	1
functionIdList	integer(int64)[]	否	角色包含的功能
template	boolean	否	是否是模板	true
companyType	string	否	公司类型	"STORE"
templateId	integer(int64)	否	模版ID	1
idaasId	string	否	idaas唯一ID
appId	integer(int64)	否	sys_app.id

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRole	否

POST

/api/reportGroup/add

报表分类添加报表分类 OperationId: add_6

调用方法

POST /api/reportGroup/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: SysReportGroupDTO$AddDTO com.leadwaycloud.system.model.dto.SysReportGroupDTO$AddDTO

名称	类型	必填	说明
name	string	是	名称
code	string	是	编号
parentId	integer(int64)	否	父级ID
merchantId	integer(int64)	是	商户ID

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysReportGroup	否

POST

/api/reportDashboard/add

仪表板配置添加仪表板配置 OperationId: add_7

调用方法

POST /api/reportDashboard/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ReportDashboardDTO$AddDTO com.leadwaycloud.system.model.dto.ReportDashboardDTO$AddDTO

名称	类型	必填	说明	示例
modelId	integer(int64)	是	模型ID	608486975133453
userId	integer(int64)	是	用户ID	618708628295069
companyId	integer(int64)	是	公司ID	574533689957252
merchantId	integer(int64)	是	商户号ID	574533689957248
reportDashboardLayoutDTOList	SysReportDashboardLayoutDTO[]	是	仪表盘自定义布局配置集合

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysReportDashboard	否

POST

/api/reasonCode/updateReasonCodeType/{typeId}

原因码管理编辑原因码类型 OperationId: updateType

调用方法

POST /api/reasonCode/updateReasonCodeType/{typeId}

参数

名称	位置	必填	类型	说明	示例
typeId	path	是	integer(int64)	类型ID	0
name	query	是	string	类型名称

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/reasonCode/add

原因码管理添加原因码 OperationId: add_8

调用方法

POST /api/reasonCode/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ReasonCodeDTO$AddDTO com.leadwaycloud.system.model.dto.ReasonCodeDTO$AddDTO

名称	类型	必填	说明	示例
code	string	是	原因码
merchantId	integer(int64)	是	商户ID	1
name	string	是	名称
typeId	integer(int64)	是	类型ID
externalCode	string	否	外部编号

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	integer(int64)	否	返回数据

POST

/api/reasonCode/addReasonCodeType

原因码管理添加原因码类型 OperationId: add_9

调用方法

POST /api/reasonCode/addReasonCodeType

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ReasonCodeTypeDTO$AddDTO com.leadwaycloud.system.model.dto.ReasonCodeTypeDTO$AddDTO

名称	类型	必填	说明	示例
name	string	是	名称
merchantId	integer(int64)	是	商户ID	1
orderType	string	是	订单类型

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	integer(int64)	否	返回数据

POST

/api/rating/topic/add

评价题库管理添加评价题库 OperationId: add_10

调用方法

POST /api/rating/topic/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ResRatingTopicDTO$AddDTO com.leadwaycloud.system.model.dto.res.ResRatingTopicDTO$AddDTO

名称	类型	必填	说明
ratingCategoryId	integer(int64)	否	评价分类id
content	string	否	内容
totalScore	integer(int64)	否	总分
merchantId	integer(int64)	否	商户id
status	string	否	状态

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	integer(int64)	否	返回数据

POST

/api/rating/template/add

评价模版管理添加评价模版 OperationId: add_11

调用方法

POST /api/rating/template/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ResRatingTemplateDTO$AddDTO com.leadwaycloud.system.model.dto.res.ResRatingTemplateDTO$AddDTO

名称	类型	必填	说明
type	string	否	模版类型(合同/其他)
totalPenalty	number(double)	否	总扣分
note	string	否	备注
name	string	否	名称
merchantId	integer(int64)	是	商户ID
companyId	integer(int64)	是	公司Id
ratingTopicIdList	integer(int64)[]	否	题库ID集合

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	integer(int64)	否	返回数据

POST

/api/rating/category/add

评价分类管理添加评价分类 OperationId: add_12

调用方法

POST /api/rating/category/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ResRatingCategoryDTO$AddDTO com.leadwaycloud.system.model.dto.res.ResRatingCategoryDTO$AddDTO

名称	类型	必填	说明
name	string	是	名称
code	string	是	编号
parentId	integer(int64)	否	上一级id
merchantId	integer(int64)	是	商户id
status	string	否	状态
ratingUserId	integer(int64)	否	评价人ID

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	integer(int64)	否	返回数据

POST

/api/rating/add

评价管理添加评价 OperationId: add_13

调用方法

POST /api/rating/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ResRatingDTO$AddDTO[] com.leadwaycloud.system.model.dto.res.ResRatingDTO$AddDTO

名称	类型	必填	说明	示例
(array)	ResRatingDTO$AddDTO[]

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/poiTemp/download

导入模版下载下载导入模版 OperationId: download

调用方法

POST /api/poiTemp/download

参数

无

请求体

Content-Type: application/json 必填: 是 类型: DownloadExportTemplateDTO com.leadwaycloud.system.model.dto.DownloadExportTemplateDTO

名称	类型	必填	说明
orderType	string	是	导出订单类型
columnDTOList	DownloadExportTemplateDTO$ColumnDTO[]	否	导出列对象集合
titleDTOList	DownloadExportTemplateDTO$TitleDTO[]	否	动态标题列集合
merchantId	integer(int64)	否	商户ID

响应

状态码: 200 说明: OK

无

POST

/api/poiTemp/add

导入模版下载添加模版配置 OperationId: add_14

调用方法

POST /api/poiTemp/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ExcelTemplateConfigDTO$AddDTO com.leadwaycloud.system.model.dto.ExcelTemplateConfigDTO$AddDTO

名称	类型	必填	说明
type	string	是	模版类型
configData	string	是	配置内容
merchantId	integer(int64)	是	商户ID
noteData	string	否	备注内容
tempData	string	否	模拟数据内容
dynamicTitleData	string	否	动态标题内容
version	string	否	版本内容

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysDataImportTemplate	否

POST

/api/loginConfig/add

用户登录配置添加登录配置 OperationId: add_15

调用方法

POST /api/loginConfig/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: LoginConfigDTO$AddDTO com.leadwaycloud.system.model.dto.LoginConfigDTO$AddDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
enableDualVerify	boolean	是	是否开启双重验证（密码+验证码）
enableEmailVerify	boolean	是	是否开启邮件验证
enableShortMessageVerify	boolean	是	是否开启短信验证
loginErrorCountCheck	boolean	是	登录错误次数校验
allowErrorCount	integer(int32)	否	允许错误次数
lockTime	integer(int32)	否	锁定时间
lockTimeUom	string	否	锁定时间单位（分、时、天）	"DAY"

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResLoginConfig	否

POST

/api/login/userName

用户登录用户名登录 OperationId: userName

用户名+密码验证登录

调用方法

POST /api/login/userName

参数

无

请求体

Content-Type: application/json 必填: 是 类型: UserLoginByUserNameDTO com.leadwaycloud.system.model.dto.login.UserLoginByUserNameDTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
loginCompanyId	integer(int64)	否	登陆公司ID
userName	string	是	用户名
password	string	是	密码
loginChannel	string	是	登陆渠道

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/login/twoFactorAuthLogin

用户登录双因素登录 OperationId: twoFactorAuthLogin

手机/邮箱验证码验证进行登录

调用方法

POST /api/login/twoFactorAuthLogin

参数

无

请求体

Content-Type: application/json 必填: 是 类型: UserLoginByTwoFactorAuthDTO com.leadwaycloud.system.model.dto.login.UserLoginByTwoFactorAuthDTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
userId	integer(int64)	是	用户ID
captcha	string	是	验证码
loginChannel	string	是	登陆渠道

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/login/shell/get-token

用户管理-壳牌获取token OperationId: getToken

调用方法

POST /api/login/shell/get-token

参数

无

请求体

Content-Type: application/json 必填: 是 类型: GetTokenDTO com.leadwaycloud.system.shell.model.dto.GetTokenDTO

名称	类型	必填	说明
grant_type	string	是	授权类型 (password: 通过账号密码获取, refresh_token：通过刷新token获取)
username	string	是	账号
password	string	是	密码
refresh_token	string	是	刷新token

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/login/mobilePhone

用户登录手机号登陆 OperationId: mobilePhone

手机+验证码登录

调用方法

POST /api/login/mobilePhone

参数

无

请求体

Content-Type: application/json 必填: 是 类型: UserLoginByMobilePhoneDTO com.leadwaycloud.system.model.dto.login.UserLoginByMobilePhoneDTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
mobilePhone	string	是	手机号
captcha	string	是	验证码
loginChannel	string	是	登陆渠道

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/login/logout

用户登录用户登出 OperationId: logout

调用方法

POST /api/login/logout

参数

名称	位置	必填	类型	说明	示例
loginChannel	query	否	string	用户登录渠道类型【 ERP_BACKEND : ECOMMERCE_PLATFORM : SUPPLIER_PLATFORM : HANDHELD_TERMINAL : 】

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/login/email

用户登录邮箱登陆 OperationId: email

邮箱+验证码登录

调用方法

POST /api/login/email

参数

无

请求体

Content-Type: application/json 必填: 是 类型: UserLoginByEmailDTO com.leadwaycloud.system.model.dto.login.UserLoginByEmailDTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
email	string	是	邮箱
captcha	string	是	验证码
loginChannel	string	是	登陆渠道

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/log/userManageLog/export

日志管理导出用户管理日志 OperationId: exportUserManageLog

调用方法

POST /api/log/userManageLog/export

参数

无

请求体

Content-Type: application/json 必填: 是 类型: UserManageLogDTO$QueryDTO com.leadwaycloud.system.plug.poi.model.dto.ExportDTOCom.leadwaycloud.system.model.dto.UserManageLogDTO$QueryDTO

名称	类型	必填	说明
reportColumnList	ReportColumnDTO[]	是	需导出参数集合
queryDTO	UserManageLogDTO$QueryDTO	是
fileName	string	是	导出文件名

响应

状态码: 200 说明: OK

无

POST

/api/log/userManageLog/add

日志管理添加用户管理日志 OperationId: addUserManageLog

调用方法

POST /api/log/userManageLog/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: UserManageLogDTO$AddDTO com.leadwaycloud.system.model.dto.UserManageLogDTO$AddDTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户ID
companyId	integer(int64)	否	公司ID
updateUserId	integer(int64)	是	编辑用户ID
updateUserName	string	是	编辑用户账号
functionId	integer(int64)	是	菜单ID
functionName	string	是	菜单名称
createBy	integer(int64)	是	创建人ID
createByName	string	是	创建人名称
responseContent	R	是

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/log/userLoginLog/export

日志管理导出用户登录日志 OperationId: exportUserLoginLog

调用方法

POST /api/log/userLoginLog/export

参数

无

请求体

Content-Type: application/json 必填: 是 类型: LoginLogDTO$QueryDTO com.leadwaycloud.system.plug.poi.model.dto.ExportDTOCom.leadwaycloud.system.model.dto.LoginLogDTO$QueryDTO

名称	类型	必填	说明
reportColumnList	ReportColumnDTO[]	是	需导出参数集合
queryDTO	LoginLogDTO$QueryDTO	是
fileName	string	是	导出文件名

响应

状态码: 200 说明: OK

无

POST

/api/log/userLoginLog/add

日志管理添加用户登录日志 OperationId: addUserLoginLog

调用方法

POST /api/log/userLoginLog/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: UserLoginLogDTO com.leadwaycloud.system.model.dto.UserLoginLogDTO

名称	类型	必填	说明
type	string	否	orientation
orientation	string	否	orientation
os	string	否	操作系统
merchantId	integer(int64)	是	商户ID
userId	integer(int64)	否	用户id
userName	string	否	用户账号
responseContent	string	否	请求结果

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/log/sessionLog/export

日志管理导出操作日志 OperationId: exportSessionLog

调用方法

POST /api/log/sessionLog/export

参数

无

请求体

Content-Type: application/json 必填: 是 类型: GatewaySessionRecordDTO com.leadwaycloud.system.plug.poi.model.dto.ExportDTOCom.leadwaycloud.system.model.dto.GatewaySessionRecordDTO

名称	类型	必填	说明
reportColumnList	ReportColumnDTO[]	是	需导出参数集合
queryDTO	GatewaySessionRecordDTO	是
fileName	string	是	导出文件名

响应

状态码: 200 说明: OK

无

POST

/api/log/clearConfig/add

日志管理添加清理配置 OperationId: addClearConfig

调用方法

POST /api/log/clearConfig/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: LogClearConfigDTO$AddDTO com.leadwaycloud.system.model.dto.LogClearConfigDTO$AddDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
reserveTime	integer(int32)	是	保留时间（单位：月）	1
status	string	是	状态（ACTIVE, DEACTIVATE）
host	string	否	IP地址(当status=ACTIVE时需要)

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResLogClearConfig	否

POST

/api/lang-translation/translation/add

语言于翻译字典添加字典，管理端使用 OperationId: listTranslation

调用方法

POST /api/lang-translation/translation/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: TranslationDTO$AddDTO[] com.leadwaycloud.system.model.dto.TranslationDTO$AddDTO

名称	类型	必填	说明	示例
(array)	TranslationDTO$AddDTO[]

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/issues/comment/add

问题评论管理添加问题评论 OperationId: add_16

调用方法

POST /api/issues/comment/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ResIssuesCommentDTO$AddDTO com.leadwaycloud.system.model.dto.res.ResIssuesCommentDTO$AddDTO

名称	类型	必填	说明
issuesId	integer(int64)	否	问题ID
parentId	integer(int64)	否	父评论ID
content	string	否	问题内容
status	string	否	问题内容
operatorId	integer(int64)	否	操作人ID

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	integer(int64)	否	返回数据

POST

/api/issues/add

问题信息添加问题 OperationId: add_17

调用方法

POST /api/issues/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ResIssuesDTO$AddDTO com.leadwaycloud.system.model.dto.res.ResIssuesDTO$AddDTO

名称	类型	必填	说明
title	string	是	问题标题
content	string	是	问题内容
originId	integer(int64)	是	业务ID
originType	string	否	合同/其他
status	string	否	状态
startDate	string(date)	否	开始日期
endDate	string(date)	否	结束日期
assignPersonIdList	integer(int64)[]	否	指派人ID集合
priority	string	否	优先级
associatedTagDTO	TagDTO$AssociatedTagDTO	否
model	string	否	类型
file	integer(int64)	否	附件
departmentIdList	integer(int64)[]	否	部门ID集合

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	integer(int64)	否	返回数据

POST

/api/idaas/callbackEiam/{merchantId}

IDaaS同步管理阿里云IDaaS-EIAM事件回调接口 OperationId: callbackEiam

调用方法

POST /api/idaas/callbackEiam/{merchantId}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)	商户号ID

请求体

Content-Type: application/json 必填: 是 类型: object

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: ResponseObject com.leadwaycloud.thirdparty.module.idaas.eiam.objects.ResponseObject

无

POST

/api/externalApplication/distribute-mapping

外部应用管理下发数据映射关系 OperationId: distributeMapping

调用方法

POST /api/externalApplication/distribute-mapping

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ExternalDataMappingDTO$DistributeDTO com.leadwaycloud.system.model.dto.ExternalDataMappingDTO$DistributeDTO

名称	类型	必填	说明
companyId	integer(int64)	是	下发映射所属公司ID
type	string	是	类型
companyIdList	integer(int64)[]	是	下发公司ID集合

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/externalApplication/distribute-config/{id}

外部应用管理下发应用基础配置 OperationId: distributeConfig

调用方法

POST /api/externalApplication/distribute-config/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	应用配置ID	0

请求体

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

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

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/externalApplication/add-config

外部应用管理添加应用基础配置 OperationId: addConfig

调用方法

POST /api/externalApplication/add-config

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ExternalAppConfigDTO$AddDTO com.leadwaycloud.system.model.dto.ExternalAppConfigDTO$AddDTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
companyId	integer(int64)	是	公司ID
businessDate	string(date)	是	营业日
shiftNo	integer(int32)	是	班次
insertCoins	string	否	投币
cashOut	string	否	现金出
customersLeaveWithoutPaying	string	否	跑单
oilGunTest	string	否	油枪测试
syncNonOilStock	boolean	是	是否同步非油库存
isAutoShelf	boolean	是	是否自动上架

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResExternalAppConfig	否

POST

/api/endOfDayConfig/shell/synchronization/{companyId}

日结配置-壳牌同步日结配置 OperationId: synchronization_1

调用方法

POST /api/endOfDayConfig/shell/synchronization/{companyId}

参数

名称	位置	必填	类型	说明	示例
companyId	path	是	integer(int64)	配置所属公司Id

请求体

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

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

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/endOfDayConfig/shell/add

日结配置-壳牌添加日结配置 OperationId: add_18

调用方法

POST /api/endOfDayConfig/shell/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: EndOfDayConfigDTO$AddDTO com.leadwaycloud.system.shell.model.dto.EndOfDayConfigDTO$AddDTO

名称	类型	必填	说明
startBusinessDate	string(date)	是	初始营业日
autoEndOfDay	boolean	是	开启自动日结
dryNegativeStockCheck	boolean	是	开启非油负库存校验
fuelInventorySummary	boolean	是	开启油品帐存差异校验
merchantId	integer(int64)	是	商户号ID
companyId	integer(int64)	是	公司ID
fuelInventorySummaryConfigDTOList	EndOfDayConfigDTO$ResFuelInventorySummaryConfigDTO[]	否	油品帐存差异配置明细

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	integer(int64)	否	返回数据

POST

/api/email/template/add

邮件模板管理添加 OperationId: add_19

调用方法

POST /api/email/template/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: EmailTemplateDTO$AddDTO com.leadwaycloud.system.model.dto.EmailTemplateDTO$AddDTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
title	string	是	标题
status	string	是	状态
type	string	是	类型
content	string	是	内容
ccRole	string	否	抄送角色ID集合
ccUser	string	否	抄送用户ID集合
addresseeUser	string	否	收件用户ID集合
notifySupplier	boolean	否	通知供应商

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	integer(int64)	否	返回数据

POST

/api/email/record/send

邮件发送记录发送邮件 OperationId: sendMerchantCustomizeEmail

调用方法

POST /api/email/record/send

参数

无

请求体

Content-Type: application/json 必填: 是 类型: EmailSendRecordDTO$SendDTO com.leadwaycloud.system.model.dto.EmailSendRecordDTO$SendDTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
companyId	integer(int64)	是	公司ID
originType	string	是	来源类型
orderCode	string	是	订单编号
addresseeUserIdList	integer(int64)[]	是	收件用户ID集合
fileBase64	string	否	fileBase64
fileName	string	否	文件名称

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/email/record/resend/{id}

邮件发送记录重新发送 OperationId: resend

调用方法

POST /api/email/record/resend/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	邮件发送记录主键ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/dynamic-task/add

动态任务管理添加任务 OperationId: addDynamicTask

调用方法

POST /api/dynamic-task/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: DynamicTaskDTO com.leadwaycloud.system.model.dto.DynamicTaskDTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
merchantId	integer(int64)	是	商户ID	1
name	string	是	名称
code	string	是	代码
cron	string	是	cron表达式
issuedSystem	string	是	推送系统	"1"
issuedType	string	是	推送类型	"1"
isActive	boolean	是	是否启用
lastTime	string(date-time)	否	最后推送时间
taskConfig	string	是	任务配置

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResDynamicTask	否

POST

/api/currency/queryRateList

货币信息批量获取货币汇率 OperationId: queryRateList

调用方法

POST /api/currency/queryRateList

参数

无

请求体

Content-Type: application/json 必填: 是 类型: CurrencyRateDTO$QueryDTO[] com.leadwaycloud.system.model.dto.CurrencyRateDTO$QueryDTO

名称	类型	必填	说明	示例
(array)	CurrencyRateDTO$QueryDTO[]

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysCurrencyRate[]	否	返回数据

POST

/api/currency/add

货币信息添加货币接口 OperationId: add_20

调用方法

POST /api/currency/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: CurrencyDTO$AddDTO com.leadwaycloud.system.model.dto.CurrencyDTO$AddDTO

名称	类型	必填	说明	示例
code	string	是	编号	"CNY"
name	string	是	名称	"人民币"
symbol	string	是	符号	"¥"
image	string	否	图片
rounding	integer(int32)	是	四舍五入精度
calcRate	boolean	是	是否计算汇率	true
calcRateUnit	number(double)	否	汇率计算单位

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysCurrency	否

POST

/api/contact/add

联系地址管理添加联系地址 OperationId: add_21

调用方法

POST /api/contact/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ContactDTO$AddDTO com.leadwaycloud.system.model.dto.ContactDTO$AddDTO

名称	类型	必填	说明	示例
countryId	integer(int64)	否	国家ID	1
stateId	integer(int64)	否	省、直辖市ID	1
cityId	integer(int64)	否	城市ID	1
areaId	integer(int64)	否	区、县ID	1
streetId	integer(int64)	否	街道ID	1
address	string	否	详细地址	"1"
postcode	string	否	邮编	"1"
phone	string	否	电话	"1"
mobile	string	否	手机	"1"
fax	string	否	传真	"1"
email	string	否	邮箱	"邮箱"

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResContact	否

POST

/api/companyGroup/association/{id}

公司组管理关联公司 OperationId: association

调用方法

POST /api/companyGroup/association/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	公司组ID

请求体

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

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

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/companyGroup/add

公司组管理添加公司组 OperationId: add_22

调用方法

POST /api/companyGroup/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: CompanyGroupDTO$AddDTO com.leadwaycloud.system.model.dto.CompanyGroupDTO$AddDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
name	string	是	名称
code	string	是	编号
description	string	否	描述
type	string	否	类型
companyIdList	integer(int64)[]	否	公司ID集合,公司组快捷绑定公司使用

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	integer(int64)	否	返回数据

POST

/api/company/shell/association-center-warehouse

公司管理-壳牌关联中央仓 OperationId: associationCenterWarehouse

调用方法

POST /api/company/shell/association-center-warehouse

参数

无

请求体

Content-Type: application/json 必填: 是 类型: AssociateCompanyCenterWarehouseDTO com.leadwaycloud.system.shell.model.dto.AssociateCompanyCenterWarehouseDTO

名称	类型	必填	说明	示例
companyIdList	integer(int64)[]	是	门店ID集合
centerWarehouseId	integer(int64)	是	中央仓ID

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/company/associationCompanyGroup/{id}

公司管理关联公司组 OperationId: associationCompanyGroup

调用方法

POST /api/company/associationCompanyGroup/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	公司ID

请求体

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

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

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/company/add

公司管理添加公司 OperationId: add_23

调用方法

POST /api/company/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: CompanyDTO$AddDTO com.leadwaycloud.system.model.dto.CompanyDTO$AddDTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID
code	string	是	公司编号（字母+数字，15位）	"CD0123456789123"
otherCode	string	否	其他编号	"AAAA-01"
type	string	是	类型	"STORE"
name	string	是	公司名称	"立威云"
image	string	否	公司LOGO
parentCompanyId	integer(int64)	是	上级公司
slogan	string	否	公司标语
currencyId	integer(int64)	否	货币ID
addContactDTO	ContactDTO$AddDTO	否
addFinanceInvoiceTitleDTO	FinanceInvoiceTitleDTO$AddDTO	否

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResCompany	否

POST

/api/code-rule/generateCodeBatch

编号规则根据规则获取编号(批量) OperationId: generateCodeBatch

调用方法

POST /api/code-rule/generateCodeBatch

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ResCodeRuleDTO$GenerateCodeBatchDTO com.leadwaycloud.common.model.dto.ResCodeRuleDTO$GenerateCodeBatchDTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
codeRuleId	integer(int64)	是	编码规则ID
num	integer(int32)	是	编号个数
batchDTOList	ResCodeRuleDTO$GenerateCodeBatchDTO$BatchDTO[]	否	批量生成编号请求参数-批次参数DTO集合

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	string[]	否	返回数据

POST

/api/code-rule/addOrUpdateList

编号规则添加/编辑编号规则集合 OperationId: addOrUpdateList

调用方法

POST /api/code-rule/addOrUpdateList

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ResCodeRuleDTO$UpdateDTO[] com.leadwaycloud.common.model.dto.ResCodeRuleDTO$UpdateDTO

名称	类型	必填	说明	示例
(array)	ResCodeRuleDTO$UpdateDTO[]

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/business-notice/shell/send

业务通知-壳牌发送业务通知 OperationId: sendMerchantCustomizeEmail_1

调用方法

POST /api/business-notice/shell/send

参数

无

请求体

Content-Type: application/json 必填: 是 类型: BusinessNoticeDTO$SendDTO com.leadwaycloud.system.shell.model.dto.BusinessNoticeDTO$SendDTO

名称	类型	必填	说明
merchantId	boolean	是	商户号ID
companyIdList	integer(int64)[]	否	公司ID
originType	string	是	来源类型
orderCode	string	否	订单编号

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

POST

/api/attachment/add

附件管理添加附件 OperationId: add_24

调用方法

POST /api/attachment/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ResAttachmentDTO$AddDTO com.leadwaycloud.system.model.dto.ResAttachmentDTO$AddDTO

名称	类型	必填	说明
companyId	integer(int64)	是	公司ID
merchantId	integer(int64)	是	商户ID
fileIndex	string	是	文件后缀
fileName	string	是	文件名称
originId	integer(int64)	否	源订单ID
originType	string	否	源订单类型
fileId	integer(int64)	是	文件ID
description	string	否	描述
originTypeSub	string	否	源订单子类型

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/attachment/addList

附件管理批量添加附件 OperationId: addList

调用方法

POST /api/attachment/addList

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ResAttachmentDTO$AddDTO[] com.leadwaycloud.system.model.dto.ResAttachmentDTO$AddDTO

名称	类型	必填	说明	示例
(array)	ResAttachmentDTO$AddDTO[]

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

POST

/api/application/add

应用管理添加应用 OperationId: add_25

调用方法

POST /api/application/add

参数

无

请求体

Content-Type: application/json 必填: 是 类型: ApplicationDTO$AddDTO com.leadwaycloud.system.model.dto.ApplicationDTO$AddDTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
sysApplicationId	integer(int64)	是	系统应用	1
name	string	是	应用名称
linkUserId	integer(int64)	否	关联用户ID
merchantId	integer(int64)	是	商户ID

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResApplication	否

GET

/api/version/queryUserUnConfirmPlatformVersion

版本管理查询用户未确认版本列表 OperationId: queryUserUnConfirmPlatformVersion

调用方法

GET /api/version/queryUserUnConfirmPlatformVersion

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysPlatformVersion	否

GET

/api/version/queryAllPlatformVersion

版本管理查询全部版本列表 OperationId: queryAllPlatformVersion

调用方法

GET /api/version/queryAllPlatformVersion

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10

请求体

无

响应

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysPlatformVersion	否

GET

/api/version/page

版本管理查询服务版本(分页) OperationId: page

调用方法

GET /api/version/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
serviceName	query	是	string	服务名称	"lwc-cloud-erp-system"

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysVersion	否

GET

/api/version/list

版本管理查询服务版本(列表) OperationId: list

调用方法

GET /api/version/list

参数

名称	位置	必填	类型	说明	示例
serviceName	query	是	string	服务名称	"lwc-cloud-erp-system"

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysVersion[]	否	返回数据

GET

/api/version/get/{serviceName}

版本管理查询服务最新版本 OperationId: get

调用方法

GET /api/version/get/{serviceName}

参数

名称	位置	必填	类型	说明	示例
serviceName	path	是	string	服务名称	"lwc-cloud-erp-system"

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysVersion	否

GET

/api/userPasswordRule/get/{merchantId}

用户密码规则管理查询密码规则 OperationId: get_1

调用方法

GET /api/userPasswordRule/get/{merchantId}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)	商户号ID	1

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResPasswordRule	否

GET

/api/user/shell/queryUserRole

用户管理-壳牌查询用户在商户下所有公司所绑定的角色列表 OperationId: queryUserRole

调用方法

GET /api/user/shell/queryUserRole

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: UserRoleVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.shell.model.vo.UserRoleVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	UserRoleVO	否

GET

/api/user/shell/queryMerchantByUserName

用户管理-壳牌根据用户名称获取商户信息 OperationId: queryMerchantByUserName

调用方法

GET /api/user/shell/queryMerchantByUserName

参数

名称	位置	必填	类型	说明	示例
userName	query	是	string	用户名

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

GET

/api/user/shell/queryCreateBy/{userId}

用户管理-壳牌单据中使用查询创建人，不通过查询详情接口 OperationId: queryCreateBy

调用方法

GET /api/user/shell/queryCreateBy/{userId}

参数

名称	位置	必填	类型	说明	示例
userId	path	是	integer(int64)	用户ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

GET

/api/user/queryUserByUsername

用户管理通过账号获取用户基本信息 OperationId: queryUserByUsername

调用方法

GET /api/user/queryUserByUsername

参数

名称	位置	必填	类型	说明	示例
userName	query	是	string	账号
merchantId	query	是	integer(int64)	商户ID

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: UserInfoVO com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.vo.user.UserInfoVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	UserInfoVO	否

GET

/api/user/queryPermissions/{id}

用户管理查询权限 OperationId: queryPermissions

调用方法

GET /api/user/queryPermissions/{id}

参数

名称	位置	必填	类型	说明
id	path	是	integer(int64)	ID
companyId	query	是	integer(int64)	公司ID
appId	query	否	integer(int64)	sys_app.id
appType	query	否	string
appCode	query	否	string	sys_app.code

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: PermissionsVO com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.vo.PermissionsVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	PermissionsVO	否

GET

/api/user/queryManagedStoreUser

用户管理查询可管理门店用户 OperationId: queryManagedStoreUser

调用方法

GET /api/user/queryManagedStoreUser

参数

名称	位置	必填	类型	说明	示例
companyId	query	是	integer(int64)	ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResUser[]	否	返回数据

GET

/api/user/page

用户管理根据筛选条件获取用户分页列表 OperationId: page_1

调用方法

GET /api/user/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
userName	query	否	string	登录名称	"admin@hyj"
name	query	否	string	用户名称	"hyj"
status	query	否	string	状态	"ACTIVE"
companyId	query	是	integer(int64)	公司ID	1
merchantId	query	否	integer(int64)	商户ID	1
roleId	query	否	integer(int64)	角色ID	1
partnerId	query	否	integer(int64)	CRM关系ID	1
partnerIdList	query	否	integer(int64)[]
idList	query	否	integer(int64)[]
departmentId	query	否	integer(int64)	部门ID	1
registerChannel	query	否	string	注册渠道【 ERP_BACKEND : ECOMMERCE_PLATFORM : IDAAS : 】
userAuditStatus	query	否	string	用户审核状态【 PENDING_REVIEW : APPROVEING : APPROVEDONE : 】
querySupplier	query	否	boolean	是否查询供应商用户（默认false）
queryEmployeeDepartmentPosition	query	否	boolean	是否查询员工-部门-职位信息
queryAdministrationCompany	query	否	boolean	是否查询可管理公司	true
queryMerchantUser	query	否	boolean	是否查询商户级用户	true

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResUser	否

GET

/api/user/get/{id}

用户管理查询用户详情 OperationId: get_2

调用方法

GET /api/user/get/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: ResUserDetailVO com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.vo.user.ResUserDetailVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResUserDetailVO	否

GET

/api/user/checkUserName

用户管理校验账号是否存在 OperationId: checkUserName

调用方法

GET /api/user/checkUserName

参数

名称	位置	必填	类型	说明	示例
userName	query	是	string	账号
merchantId	query	否	integer(int64)	商户号ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

GET

/api/uom/page

计量单位信息查询计量单位(分页)接口 OperationId: pageQuery

调用方法

GET /api/uom/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
code	query	否	string	编号	1
name	query	否	string	名称	"公斤"
symbol	query	否	string	符号	"kg"
shortName	query	否	string	简称
merchantId	query	否	integer(int64)	商户ID
active	query	否	boolean	是否是可用的	true
isoShortName	query	否	string	ISO名称

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysUom	否

GET

/api/uom/get/{id}

计量单位信息查询计量单位(ID)接口 OperationId: get_3

调用方法

GET /api/uom/get/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysUom	否

GET

/api/trip-line/query/{id}

航线管理查询航线数据 OperationId: queryTripLine

调用方法

GET /api/trip-line/query/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	id	1

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResTripLine	否

GET

/api/trip-line/query/line-id/{lineId}

航线管理查询航线数据 OperationId: queryTripLineByLineId

调用方法

GET /api/trip-line/query/line-id/{lineId}

参数

名称	位置	必填	类型	说明	示例
lineId	path	是	integer(int64)	航线ID	49

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResTripLine[]	否	返回数据

GET

/api/trip-line/query/cruise-id/{cruiseId}

航线管理查询航线数据 OperationId: queryTripLineByCruiseId

调用方法

GET /api/trip-line/query/cruise-id/{cruiseId}

参数

名称	位置	必填	类型	说明	示例
cruiseId	path	是	integer(int64)	邮轮ID	49

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResTripLine[]	否	返回数据

GET

/api/trip-line/page-query

航线管理分页查询航线数据 OperationId: pageQueryTripLine

调用方法

GET /api/trip-line/page-query

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
merchantId	query	是	integer(int64)	商户ID	1
name	query	否	string	航线名称	"上海-冲绳-上海"
code	query	否	string	航次编号	"NB04250102"
cruiseId	query	否	string	游船编号	1624
hot	query	否	boolean	？？？	false
enable	query	否	boolean	？？？	false
departureDate	query	否	string(date)	出发日期	"2021-01-01"
days	query	否	integer(int32)	航行天数
passage	query	否	boolean	是否在途	true
status	query	否	string	状态【 ACTIVE : DEACTIVATE : DELETE : 】	"ACTIVE"

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResTripLine	否

GET

/api/tag/queryGroupList

标签管理获取标签组列表 OperationId: queryGroupList

调用方法

GET /api/tag/queryGroupList

参数

名称	位置	必填	类型	说明	示例
merchantId	query	是	integer(int64)
name	query	否	string	组名称	0

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResTagGroup[]	否	返回数据

GET

/api/tag/queryAssociatedTag

标签管理查询关联标签 OperationId: queryAssociatedTag

调用方法

GET /api/tag/queryAssociatedTag

参数

名称	位置	必填	类型	说明	示例
associateId	query	是	integer(int64)	关联ID	0
associateType	query	是	string	关联类型

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResTag[]	否	返回数据

GET

/api/tag/page

标签管理查询标签列表 OperationId: page_2

调用方法

GET /api/tag/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
name	query	否	string	标签名称
merchantId	query	是	integer(int64)	商户ID	1
groupId	query	否	integer(int64)	组ID	1
type	query	否	string	类型	1
status	query	否	string	状态(ACTIVE:可用,DEACTIVATE:停用) 【 ACTIVE : DEACTIVATE : DELETE : 】

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResTag	否

GET

/api/tag/get/{id}

标签管理查询标签详情 OperationId: get_4

调用方法

GET /api/tag/get/{id}

参数

名称	位置	必填	类型	说明	示例
id	query	是	integer(int64)	标签ID	0

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResTag	否

GET

/api/sys/property/page

系统公用属性查询系统属性列表(分页) OperationId: page_3

调用方法

GET /api/sys/property/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
name	query	否	string	名称
group	query	否	string	分组
active	query	否	boolean	是否可用
merchantId	query	否	integer(int64)	商户ID
isQreciseQueryGroup	query	否	boolean	是否精准查询group（组）默认false

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysProperty	否

GET

/api/sys/property/list

系统公用属性查询系统属性列表 OperationId: list_1

调用方法

GET /api/sys/property/list

参数

名称	位置	必填	类型	说明
name	query	否	string	名称
group	query	否	string	分组
active	query	否	boolean	是否可用
merchantId	query	否	integer(int64)	商户ID
isQreciseQueryGroup	query	否	boolean	是否精准查询group（组）默认false

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysProperty[]	否	返回数据

GET

/api/sys/property/get

系统公用属性查询系统属性 OperationId: query

调用方法

GET /api/sys/property/get

参数

名称	位置	必填	类型	说明	示例
id	query	是	integer(int64)	属性ID	0

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysProperty	否

GET

/api/shift-reconciliation-config/shell/get

班结配置-壳牌查询班结配置 OperationId: query_1

调用方法

GET /api/shift-reconciliation-config/shell/get

参数

名称	位置	必填	类型	说明	示例
companyId	query	是	integer(int64)	公司ID

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: ResShiftReconciliationConfig com.leadwaycloud.core.model.RCom.leadwaycloud.system.shell.model.entitys.ResShiftReconciliationConfig

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResShiftReconciliationConfig	否

GET

/api/role/shell/queryRoleFunction

角色管理-壳牌角色权限功能表 OperationId: queryRoleFunction

调用方法

GET /api/role/shell/queryRoleFunction

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: RoleFunctionVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.shell.model.vo.RoleFunctionVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RoleFunctionVO	否

GET

/api/role/queryUsers/{id}

角色管理根据ID查询角色下用户信息 OperationId: queryUsers

调用方法

GET /api/role/queryUsers/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResUser[]	否	返回数据

GET

/api/role/queryUserRole/{userId}

角色管理查询用户绑定的角色集合 OperationId: queryUserRole_1

调用方法

GET /api/role/queryUserRole/{userId}

参数

名称	位置	必填	类型	说明	示例
userId	path	是	integer(int64)	用户ID

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: RoleListVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.vo.role.RoleListVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RoleListVO[]	否	返回数据

GET

/api/role/queryUserBindRole/{userId}

角色管理查询用户可管理公司下绑定的角色集合 OperationId: queryUserBindRole

调用方法

GET /api/role/queryUserBindRole/{userId}

参数

名称	位置	必填	类型	说明	示例
userId	path	是	integer(int64)	用户ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRole[]	否	返回数据

GET

/api/role/queryDistributedStore/{id}

角色管理查看角色模板已下发门店 OperationId: queryDistributedStore

调用方法

GET /api/role/queryDistributedStore/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	角色模板ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	integer(int64)[]	否	返回数据

GET

/api/role/page

角色管理查询角色分页列表 OperationId: page_4

调用方法

GET /api/role/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
companyId	query	是	integer(int64)	公司ID	1
name	query	否	string	角色名称	"运维组"
system	query	否	boolean	是否是系统创建角色	true
companyType	query	否	string	公司类型	"STORE"
template	query	否	boolean	是否是模板	true
appId	query	否	integer(int64)	sys_app.id

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRole	否

GET

/api/role/list

角色管理查询角色列表 OperationId: list_2

调用方法

GET /api/role/list

参数

名称	位置	必填	类型	说明	示例
roleDTO	query	是	RoleDTO$QueryDTO

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRole[]	否	返回数据

GET

/api/role/get/{id}

角色管理根据ID查询角色详情 OperationId: get_5

调用方法

GET /api/role/get/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: RoleDetailsVO com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.vo.RoleDetailsVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RoleDetailsVO	否

GET

/api/role/defaultPermissions

角色管理查询默认角色功能 OperationId: defaultPermissions

调用方法

GET /api/role/defaultPermissions

参数

名称	位置	必填	类型	说明	示例
merchantIndustry	query	是	string	商户行业	"TRADE"
companyType	query	是	string	公司类型	"STORE"

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: PermissionsVO com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.vo.PermissionsVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	PermissionsVO	否

GET

/api/reportGroup/list

报表分类获取报表分类列表 OperationId: list_3

调用方法

GET /api/reportGroup/list

参数

名称	位置	必填	类型	说明
merchantId	query	是	integer(int64)	商户ID
name	query	否	string	名称
statusList	query	否	string	状态
idChain	query	否	string	完整的组织结构

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysReportGroup[]	否	返回数据

GET

/api/reportDashboard/get/{companyId}/{modelId}/{userId}

仪表板配置查询仪表板配置 OperationId: get_6

调用方法

GET /api/reportDashboard/get/{companyId}/{modelId}/{userId}

参数

名称	位置	必填	类型	说明
companyId	path	是	integer(int64)	公司ID
modelId	path	是	integer(int64)	模块ID
userId	path	是	integer(int64)	用户ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysReportDashboard	否

GET

/api/report/queryReportRole/{companyId}/{reportId}

报表配置查询报表绑定用户或者角色集合 OperationId: queryReportRole

调用方法

GET /api/report/queryReportRole/{companyId}/{reportId}

参数

名称	位置	必填	类型	说明	示例
companyId	path	是	integer(int64)
reportId	path	是	integer(int64)

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: ReportRefVO com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.vo.ReportRefVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ReportRefVO	否

GET

/api/report/page

报表配置分页查询报表 OperationId: page_5

调用方法

GET /api/report/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
modelId	query	否	integer(int64)	所属模块
name	query	否	string	名称	"xxx报表"
alias	query	否	string	别名	"xxx报表"
merchantIndustry	query	否	string	商户行业	"COMPLEX"
companyType	query	否	string	公司类型	"STORE"
merchantId	query	否	integer(int64)	商户
type	query	否	string	类型	"EXCEL"
uesType	query	否	string	用途类型	"DASHBOARD"
idList	query	否	integer(int64)[]
reportGroupIdList	query	否	integer(int64)[]
customization	query	否	boolean	是否定制报表，如果是定制报表则需要增加商户号ID进行查询，默认值为false(非定制)；

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysReport	否

GET

/api/report/page-use

报表配置分页查询用户可用报表 OperationId: pageUse

调用方法

GET /api/report/page-use

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
modelId	query	否	integer(int64)	模块ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysReport	否

GET

/api/reasonCode/queryReasonCodeTypeList

原因码管理获取原因码类型列表 OperationId: queryTypeList

调用方法

GET /api/reasonCode/queryReasonCodeTypeList

参数

名称	位置	必填	类型	说明	示例
merchantId	query	是	integer(int64)	商户ID	0

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResReasonCodeType[]	否	返回数据

GET

/api/reasonCode/list

原因码管理查询原因码列表 OperationId: list_4

调用方法

GET /api/reasonCode/list

参数

名称	位置	必填	类型	说明
merchantId	query	是	integer(int64)	商户ID
code	query	否	string	原因码
name	query	否	string	原因码名称
typeName	query	否	string	原因类型名称
typeId	query	否	integer(int64)	类型ID
orderType	query	否	string	单据类型【 INVENTORY_ADJUST_ORDER : PURCHASE_ORDER : INVENTORY_RECEIVE_ORDER : OIL_CHANGE : OIL_STOCK_INVENTORY : OIL_CHANGE_NO : OIL_CHANGE_TANK : OIL_CHANGE_LOSS : OIL_PROFIT_LOSS_INQUIRY : 】
externalCode	query	否	string	外部编号

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResReasonCode[]	否	返回数据

GET

/api/reasonCode/get/{id}

原因码管理查询原因码 OperationId: get_7

调用方法

GET /api/reasonCode/get/{id}

参数

名称	位置	必填	类型	说明	示例
id	query	是	integer(int64)	原因码ID	0

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResReasonCode	否

GET

/api/rating/topic/list

评价题库管理查询评价题库列表 OperationId: list_5

调用方法

GET /api/rating/topic/list

参数

名称	位置	必填	类型	说明
ratingCategoryId	query	否	integer(int64)	评价分类id
content	query	否	string	内容
totalScore	query	否	integer(int64)	总分
merchantId	query	否	integer(int64)	商户id
status	query	否	string	状态【 ACTIVE : DEACTIVATE : DELETE : 】

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRatingTopic[]	否	返回数据

GET

/api/rating/topic/get/{id}

评价题库管理查询评价题库详情 OperationId: get_8

调用方法

GET /api/rating/topic/get/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	题库ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRatingTopic	否

GET

/api/rating/template/page

评价模版管理查询评价模版分页 OperationId: page_6

调用方法

GET /api/rating/template/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
type	query	否	string	模版类型(合同/其他)
status	query	否	string	问题内容【 ACTIVE : DEACTIVATE : DELETE : 】
name	query	否	string	名称
merchantId	query	是	integer(int64)	商户ID
companyId	query	是	integer(int64)	公司Id

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRatingTemplate	否

GET

/api/rating/template/list

评价模版管理查询评价模版列表 OperationId: list_6

调用方法

GET /api/rating/template/list

参数

名称	位置	必填	类型	说明
type	query	否	string	模版类型(合同/其他)
status	query	否	string	问题内容【 ACTIVE : DEACTIVATE : DELETE : 】
name	query	否	string	名称
merchantId	query	是	integer(int64)	商户ID
companyId	query	是	integer(int64)	公司Id

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRatingTemplate[]	否	返回数据

GET

/api/rating/template/get/{id}

评价模版管理查询评价模版详情 OperationId: get_9

调用方法

GET /api/rating/template/get/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	问题评价ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRatingTemplate	否

GET

/api/rating/list

评价管理查询评价列表 OperationId: list_7

调用方法

GET /api/rating/list

参数

名称	位置	必填	类型	说明
originType	query	否	string	源订单类型【 SALE_CONTRACT : PURCHASE_CONTRACT : 】
originId	query	否	integer(int64)	源订单id
totalPenalty	query	否	number(double)	总扣分
status	query	否	string	状态【 WAIT_START : CONFIRM : DONE : CANCEL : 】
ratingUserId	query	否	integer(int64)	评价人
operatorId	query	否	integer(int64)	经办人id

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRating[]	否	返回数据

GET

/api/rating/getRating

评价管理根据评价人查询评价详情 OperationId: getRating

调用方法

GET /api/rating/getRating

参数

名称	位置	必填	类型	说明	示例
ratingId	query	是	integer(int64)	评价ID
ratingUserId	query	否	integer(int64)	评价人

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRating	否

GET

/api/rating/get/{id}

评价管理查询评价详情 OperationId: get_10

调用方法

GET /api/rating/get/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	评价ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRating	否

GET

/api/rating/category/list

评价分类管理查询评价分类列表 OperationId: list_8

调用方法

GET /api/rating/category/list

参数

名称	位置	必填	类型	说明
name	query	否	string	名称
code	query	否	string	编号
merchantId	query	是	integer(int64)	商户id
status	query	否	string	状态【 ACTIVE : DEACTIVATE : DELETE : 】
ratingUserId	query	否	integer(int64)	评价人ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRatingCategory[]	否	返回数据

GET

/api/rating/category/get/{id}

评价分类管理查询评价分类详情 OperationId: get_11

调用方法

GET /api/rating/category/get/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	合同评价ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRatingCategory	否

GET

/api/printerTemplateConfig/list

系统打印机模板配置管理查询模板配置列表 OperationId: list_9

调用方法

GET /api/printerTemplateConfig/list

参数

名称	位置	必填	类型	说明
name	query	否	string	名称
status	query	否	string	状态
type	query	是	string	模版类型
reportId	query	否	integer(int64)	报表ID
receiptCode	query	否	string	单据代号
receiptCodeList	query	否	string[]
apiId	query	否	integer(int64)	打印模板对应的数据源API ID
merchantId	query	是	integer(int64)	商户ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysPrinterTemplateConfig[]	否	返回数据

GET

/api/printerTemplateConfig/get/{id}

系统打印机模板配置管理查询模板配置 OperationId: get_12

调用方法

GET /api/printerTemplateConfig/get/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	打印机模版ID	0

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysPrinterTemplateConfig	否

GET

/api/poiTemp/query/{merchantId}/{type}

导入模版下载根据商户和类型获取配置 OperationId: query_2

调用方法

GET /api/poiTemp/query/{merchantId}/{type}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)
type	path	是	string	【 SALE_ORDER : PURCHASE_ORDER : INVENTORY_DELIVERY_ORDER : INVENTORY_RECEIVE_ORDER : TRANSFER_CROSS_ORDER : STOCK_INVENTORY_ORDER : GOODS_BRAND : GOODS_CATEGORY : GOODS : SALE_CONTRACT : PURCHASE_CONTRACT : GOODS_UPDATE : CUSTOMER : MEMBER : SUPPLIER : MEMBER_ACCOUNT_EQUITY : INGREDIENT : STANDARD_GOODS : PURCHASE_CONTRACT_INGREDIENT : PURCHASE_DECALS_CONTRACT_INGREDIENT : SALE_CONTRACT_PRODUCT : COMPREHENSIVE_SERVICES : OUTSIDE_SERVICE_DEVICE : FINANCE_PURCHASE_INVOICE_INGREDIENT : PURCHASE_PLAN : 】

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysDataImportTemplate	否

GET

/api/operationalDoc/page

系统操作文档管理接口查询系统操作文档分页列表 OperationId: operationalDocPage

调用方法

GET /api/operationalDoc/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
industry	query	是	string	行业	"COMPLEX"
modelId	query	否	integer(int64)	系统模块ID
modelName	query	否	string	模块名称
menuName	query	否	string	自定义菜单
fileName	query	否	string	文件名称

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysOperationalDoc	否

GET

/api/operationalDoc/get/{id}

系统操作文档管理接口根据ID查询系统操作文档 OperationId: get_13

调用方法

GET /api/operationalDoc/get/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysOperationalDoc	否

GET

/api/operationalDoc/get/haveOperationalDocModel

系统操作文档管理接口查询行业具有操作文档的模块 OperationId: queryHaveOperationalDocModelList

调用方法

GET /api/operationalDoc/get/haveOperationalDocModel

参数

名称	位置	必填	类型	说明	示例
industry	query	是	string	行业	"COMPLEX"

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysModel[]	否	返回数据

GET

/api/openApiLog/page

系统请求日志分页查询系统请求日志 OperationId: page_7

调用方法

GET /api/openApiLog/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
merchantId	query	是	integer(int64)	商户号ID
businessType	query	否	string	业务类型
interactSys	query	否	string	系统
interactFunction	query	否	string	功能
success	query	否	boolean	是否处理成功/失败
startRequestTime	query	否	string(date-time)	开始请求时间
endRequestTime	query	否	string(date-time)	结束请求时间
syncDirection	query	否	integer(int32)	推送方向
batch	query	否	string	批次

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResOpenApiLog	否

GET

/api/openApiLog/get/{id}

系统请求日志查询系统请求日志详情 OperationId: get_14

调用方法

GET /api/openApiLog/get/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	系统请求日志ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResOpenApiLog	否

GET

/api/monitor/version

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

调用方法

GET /api/monitor/version

参数

无

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

GET

/api/monitor/health

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

调用方法

GET /api/monitor/health

参数

无

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

GET

/api/model/list

模块管理查询商户可使用的模块列表 OperationId: list_10

调用方法

GET /api/model/list

参数

无

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysModel[]	否	返回数据

GET

/api/merchant/query/{code}

商户信息根据code查询商户详情 OperationId: query_3

调用方法

GET /api/merchant/query/{code}

参数

名称	位置	必填	类型	说明	示例
code	path	是	string	Code	1

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResMerchant	否

GET

/api/loginConfig/get

用户登录配置查询商户登录配置 OperationId: get_15

调用方法

GET /api/loginConfig/get

参数

名称	位置	必填	类型	说明	示例
merchantId	query	是	integer(int64)	商户ID	0

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResLoginConfig	否

GET

/api/login/getLoginUserInfo

用户登录获取登录用户信息 OperationId: getLoginUserInfo

调用方法

GET /api/login/getLoginUserInfo

参数

名称	位置	必填	类型	说明	示例
allowLoginChannel	query	是	string	登录渠道【 ERP_BACKEND : ECOMMERCE_PLATFORM : SUPPLIER_PLATFORM : HANDHELD_TERMINAL : 】

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

GET

/api/log/userManageLog/page

日志管理查询用户管理日志分页列表 OperationId: userManageLogPage

调用方法

GET /api/log/userManageLog/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
queryDTO	query	是	UserManageLogDTO$QueryDTO

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResUserManageLog	否

GET

/api/log/userManageLog/function

日志管理查询用户管理日志function OperationId: queryUserManageLogFunction

调用方法

GET /api/log/userManageLog/function

参数

无

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysFunction[]	否	返回数据

GET

/api/log/userLoginLog/page

日志管理获取用户登录日志分页列表 OperationId: userLoginLogPage

调用方法

GET /api/log/userLoginLog/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
userName	query	否	string	用户账号
userId	query	否	integer(int64)	用户ID
startTime	query	否	string(date-time)	开始时间
endTime	query	否	string(date-time)	结束时间

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResUserLoginLog	否

GET

/api/log/sessionLog/page

日志管理查询操作日志分页列表 OperationId: sessionLogPage

调用方法

GET /api/log/sessionLog/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
companyId	query	否	integer(int64)	公司ID
functionId	query	否	integer(int64)	功能ID
userId	query	否	integer(int64)	用户ID
appId	query	否	integer(int64)	sys_app.id
startTime	query	否	string(date-time)	开始时间
endTime	query	否	string(date-time)	结束时间

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysGatewaySessionRecord	否

GET

/api/log/clearConfig/query

日志管理查询商户配置 OperationId: queryClearConfig

调用方法

GET /api/log/clearConfig/query

参数

名称	位置	必填	类型	说明	示例
merchantId	query	是	integer(int64)	商户ID	1

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResLogClearConfig	否

GET

/api/lang-translation/translation/{merchantId}/{langCode}

语言于翻译字典前端获取翻译字典JSON OperationId: listOneTranslation

调用方法

GET /api/lang-translation/translation/{merchantId}/{langCode}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)	商户ID	1
langCode	path	是	string	语言CODE	"zh_CN"

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: string

无

GET

/api/lang-translation/translation/list

语言于翻译字典查询翻译字典 OperationId: listTranslation_1

调用方法

GET /api/lang-translation/translation/list

参数

名称	位置	必填	类型	说明	示例
merchantId	query	否	integer(int64)	商户
languageCode	query	否	string	语言编码	"zh_CN"
languageName	query	否	string	语言名称	"Chinese (CN) / 简体中文"
merchantIndustry	query	否	string	行业	"COMPLEX_RETAIL"
application	query	否	string	应用	"crm"
module	query	否	string	模块	"common"
key	query	否	string	字典key	"K222u3u38"
value	query	否	string	字典翻译	"这是翻译"

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResTranslation[]	否	返回数据

GET

/api/lang-translation/lang/list

语言于翻译字典支持语言列表 OperationId: listLang

调用方法

GET /api/lang-translation/lang/list

参数

名称	位置	必填	类型	说明	示例
code	query	否	string	编号	"zh_CN"
name	query	否	string	名称	"Chinese (CN) / 简体中文"
active	query	否	boolean	是否可用	true
merchantId	query	否	integer(int64)	商户
langId	query	否	integer(int64)	语言

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResLang[]	否	返回数据

GET

/api/issues/page

问题信息查询问题列表 OperationId: page_8

调用方法

GET /api/issues/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
title	query	否	string	问题标题
originId	query	是	integer(int64)	业务ID
originType	query	否	string	合同/其他【 CONTRACT : OTHER : 】
status	query	否	string	状态【 DONE : PENDING : CONFIRM : CLOSE : 】
startDate	query	否	string(date)	开始日期
endDate	query	否	string(date)	结束日期
assignPersonIdList	query	否	integer(int64)[]
priority	query	否	string	优先级【 NOT_SPECIFIED : SEVERITY : MAIN : MINOR : UN_IMPORTANCE : 】
model	query	否	string	类型【 SYSTEM_ISSUE : PROBLEM_FEEDBACK : MEMBER_DISCUSSION : WH_LEAN_CREATIVITY_PROPOSAL : 】
departmentIdList	query	否	integer(int64)[]
queryCreateBy	query	否	boolean	是否查询自己发起的

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResIssues	否

GET

/api/issues/get/{id}

问题信息查询问题详情 OperationId: get_16

调用方法

GET /api/issues/get/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	问题ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResIssues	否

GET

/api/issues/comment/list

问题评论管理查询问题评论列表 OperationId: list_11

调用方法

GET /api/issues/comment/list

参数

名称	位置	必填	类型	说明
issuesId	query	是	integer(int64)	问题ID
content	query	否	string	问题内容
status	query	否	string	问题内容【 ACTIVE : DEACTIVATE : DELETE : 】
operatorId	query	否	integer(int64)	操作人ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResIssuesComment[]	否	返回数据

GET

/api/import-template/get

导入模板管理查询导入模板 OperationId: get_17

调用方法

GET /api/import-template/get

参数

名称	位置	必填	类型	说明	示例
type	query	是	string	导入模板类型	"GOODS"

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysImportTemplate	否

GET

/api/idaasConfig/queryConfig

IDaaS配置管理查询IDaaS配置 OperationId: queryConfig

调用方法

GET /api/idaasConfig/queryConfig

参数

无

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResIdaasConfig	否

GET

/api/externalApplication/query-mapping

外部应用管理查询数据映射关系 OperationId: queryMapping

调用方法

GET /api/externalApplication/query-mapping

参数

名称	位置	必填	类型	说明	示例
companyId	query	是	integer(int64)	公司ID	0
type	query	是	string	类型	"OIL_TANK"

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResExternalDataMapping[]	否	返回数据

GET

/api/externalApplication/query-config

外部应用管理查询应用基础配置 OperationId: queryConfig_1

调用方法

GET /api/externalApplication/query-config

参数

名称	位置	必填	类型	说明	示例
companyId	query	是	integer(int64)	公司ID	0

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResExternalAppConfig	否

GET

/api/endOfDayConfig/shell/get

日结配置-壳牌编辑日结配置 OperationId: query_4

调用方法

GET /api/endOfDayConfig/shell/get

参数

名称	位置	必填	类型	说明	示例
companyId	query	是	integer(int64)	公司ID

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: ResEndOfDayConfig com.leadwaycloud.core.model.RCom.leadwaycloud.system.shell.model.entitys.ResEndOfDayConfig

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResEndOfDayConfig	否

GET

/api/email/template/page

邮件模板管理查询 OperationId: queryMapping_1

调用方法

GET /api/email/template/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
queryDTO	query	是	EmailTemplateDTO$QueryDTO

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResEmailTemplate	否

GET

/api/email/template/get/{id}

邮件模板管理查询详情 OperationId: get_18

调用方法

GET /api/email/template/get/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResEmailTemplate	否

GET

/api/email/record/page

邮件发送记录查询 OperationId: page_9

调用方法

GET /api/email/record/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
queryDTO	query	是	EmailSendRecordDTO$QueryDTO

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResEmailSendRecord	否

GET

/api/dynamic-task/list

动态任务管理查询任务列表 OperationId: queryDynamicTask

调用方法

GET /api/dynamic-task/list

参数

名称	位置	必填	类型	说明	示例
merchantId	query	是	integer(int64)	商户ID
companyId	query	是	integer(int64)	门店ID
search	query	否	string	动态查询参数
sort	query	否	string	动态排序	"startDate,asc"
page	query	否	integer(int32)	查询页码	0
size	query	否	integer(int32)	查询页行数	10

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResDynamicTask	否

GET

/api/dynamic-task/get/{id}

动态任务管理查询任务详情 OperationId: get_19

调用方法

GET /api/dynamic-task/get/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResDynamicTask	否

GET

/api/deviceCommand/list

设备指令信息查询所有设备指令信息 OperationId: list_12

调用方法

GET /api/deviceCommand/list

参数

名称	位置	必填	类型	说明	示例
brand	query	否	string	品牌
model	query	否	string	型号
types	query	否	string	设备类型(PRINTER:打印机)	"PRINTER"

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysDeviceCommand[]	否	返回数据

GET

/api/currency/queryRate

货币信息查询货币汇率接口 OperationId: queryRate

调用方法

GET /api/currency/queryRate

参数

名称	位置	必填	类型	说明	示例
localDate	query	是	string	查询日	"2020-11-20"
fromCurrencyId	query	是	integer(int64)	源货币	1
toCurrencyId	query	是	integer(int64)	兑换货币	1

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysCurrencyRate	否

GET

/api/currency/queryRatePage

货币信息查询货币汇率(分页)接口 OperationId: queryRate_1

调用方法

GET /api/currency/queryRatePage

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
localDate	query	是	string	查询日	"2020-11-20"

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysCurrencyRate	否

GET

/api/currency/queryCode/{code}

货币信息查询货币(代号)接口 OperationId: queryByCode

调用方法

GET /api/currency/queryCode/{code}

参数

名称	位置	必填	类型	说明	示例
code	path	是	string	代号	"CNY"

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysCurrency	否

GET

/api/currency/page

货币信息查询货币(分页)接口 OperationId: page_10

调用方法

GET /api/currency/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
code	query	否	string	编号	"CNY"
name	query	否	string	名称	"人民币"
symbol	query	否	string	符号	"¥"
active	query	否	boolean	是否可用	true

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysCurrency	否

GET

/api/currency/list

货币信息查询所有货币信息 OperationId: list_13

调用方法

GET /api/currency/list

参数

无

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysCurrency[]	否	返回数据

GET

/api/currency/get/{id}

货币信息查询货币(ID)接口 OperationId: get_20

调用方法

GET /api/currency/get/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysCurrency	否

GET

/api/contact/queryAdministrativeDivisions

联系地址管理获取五级联动数据接口 OperationId: getAdministrativeDivisions

调用方法

GET /api/contact/queryAdministrativeDivisions

参数

名称	位置	必填	类型	说明	示例
type	query	是	string	类型	"COUNTRY"
parentId	query	否	integer(int64)	上一级ID；国家/地区类型时,可不提供	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: AddressVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.vo.AddressVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	AddressVO[]	否	返回数据

GET

/api/contact/get/{id}

联系地址管理根据ID查询联系地址 OperationId: get_21

调用方法

GET /api/contact/get/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResContact	否

GET

/api/companyGroup/page

公司组管理查询公司组分页列表 OperationId: page_11

调用方法

GET /api/companyGroup/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
merchantId	query	是	integer(int64)	商户ID	1
name	query	否	string	名称
companyId	query	否	integer(int64)	分组下公司ID	1
code	query	否	string	编号
status	query	否	string	状态【 ACTIVE : DEACTIVATE : DELETE : 】
type	query	否	string	类型【 PURCHASE_AREA : SALE_AREA : MANAGER_AREA : DISTRIBUTION_AREA : FINANCE_AREA : 】

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: CompanyGroupListVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.model.vo.company.CompanyGroupListVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	CompanyGroupListVO	否

GET

/api/companyGroup/get/{id}

公司组管理查询公司组详情 OperationId: get_22

调用方法

GET /api/companyGroup/get/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	公司组ID	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: CompanyGroupDetailVO com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.vo.company.CompanyGroupDetailVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	CompanyGroupDetailVO	否

GET

/api/company/shell/query-delivery-company/{id}

公司管理-壳牌查询中央仓已绑定的油站列表 OperationId: queryDeliveryCompany

调用方法

GET /api/company/shell/query-delivery-company/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	中央仓ID

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: CenterStoreVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.shell.model.vo.CenterStoreVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	CenterStoreVO[]	否	返回数据

GET

/api/company/shell/query-belong-center-warehouse/{id}

公司管理-壳牌查询油站已绑定中央仓 OperationId: queryBelongCenterWarehouse

调用方法

GET /api/company/shell/query-belong-center-warehouse/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	油站ID

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: CenterStoreVO com.leadwaycloud.core.model.RCom.leadwaycloud.system.shell.model.vo.CenterStoreVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	CenterStoreVO	否

GET

/api/company/shell/query-belong-center-warehouse-by-companyIdList

公司管理-壳牌查询油站已绑定中央仓(传油站集合) OperationId: queryBelongCenterWarehouseByCompanyIdList

调用方法

GET /api/company/shell/query-belong-center-warehouse-by-companyIdList

参数

名称	位置	必填	类型	说明	示例
companyIdList	query	是	integer(int64)[]
id	query	是	integer(int64)	油站ID集合

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: CenterWarehouseVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.shell.model.vo.CenterWarehouseVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	CenterWarehouseVO[]	否	返回数据

GET

/api/company/queryManageableCompany

公司管理 - OperationId: queryManageableCompany

调用方法

GET /api/company/queryManageableCompany

参数

名称	位置	必填	类型	说明	示例
name	query	否	string	公司名称	"立威云"
code	query	否	string	公司编号	"CD0123456789123"
type	query	否	string	类型	"STORE"
merchantId	query	是	integer(int64)	商户ID
tagName	query	否	string	标签名称
groupName	query	否	string	公司组名称
userId	query	是	integer(int64)	用户ID(根据用户ID查询可管理公司ID)

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: ManageableCompanyVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.vo.ManageableCompanyVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ManageableCompanyVO[]	否	返回数据

GET

/api/company/queryAdministrativeUsers/{id}

公司管理查询公司关联中指定公司的用户列表 OperationId: queryAdministrativeUsers

调用方法

GET /api/company/queryAdministrativeUsers/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	公司ID	1
userCompanyId	query	是	integer(int64)	用户所属公司ID	1

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResUser[]	否	返回数据

GET

/api/company/public/get/{id}

公司管理根据公司ID查询公司详情 OperationId: getCompanyPublicDetail

调用方法

GET /api/company/public/get/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: PublicCompanyVO com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.vo.company.PublicCompanyVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	PublicCompanyVO	否

GET

/api/company/list

公司管理获取公司列表 OperationId: list_14

调用方法

GET /api/company/list

参数

名称	位置	必填	类型	说明	示例
idList	query	否	integer(int64)[]	主键ID
code	query	否	string	公司编号（字母+数字，15位）	"CD0123456789123"
otherCode	query	否	string	其他编号	"AAAA-01"
type	query	否	string	类型	"STORE"
status	query	否	string	状态	"IN_OPERATION"
name	query	否	string	公司名称	"立威云"
parentId	query	否	integer(int64)	上级公司ID
tagName	query	否	string	标签名称
groupName	query	否	string	公司组名称
groupCode	query	否	string	公司组编号
merchantId	query	否	integer(int64)	商户ID,merchantId与merchantCode任意传一个参数
merchantCode	query	否	string	商户号,merchantId与merchantCode任意传一个参数
groupType	query	否	string	公司组类型【 PURCHASE_AREA : SALE_AREA : MANAGER_AREA : DISTRIBUTION_AREA : FINANCE_AREA : 】

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: CompanyListVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.vo.CompanyListVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	CompanyListVO[]	否	返回数据

GET

/api/company/list/{merchantId}

公司管理获取公司列表（已废弃，请使用 /list?merchantId=xxx） OperationId: lists 已废弃

调用方法

GET /api/company/list/{merchantId}

参数

名称	位置	必填	类型	说明	示例
merchantId	path	是	integer(int64)	商户号ID
idList	query	否	integer(int64)[]	主键ID
code	query	否	string	公司编号（字母+数字，15位）	"CD0123456789123"
otherCode	query	否	string	其他编号	"AAAA-01"
type	query	否	string	类型	"STORE"
status	query	否	string	状态	"IN_OPERATION"
name	query	否	string	公司名称	"立威云"
parentId	query	否	integer(int64)	上级公司ID
tagName	query	否	string	标签名称
groupName	query	否	string	公司组名称
groupCode	query	否	string	公司组编号
merchantCode	query	否	string	商户号,merchantId与merchantCode任意传一个参数
groupType	query	否	string	公司组类型【 PURCHASE_AREA : SALE_AREA : MANAGER_AREA : DISTRIBUTION_AREA : FINANCE_AREA : 】

请求体

无

响应

状态码: 200 说明: OK Content-Type: */* 类型: CompanyListVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.vo.CompanyListVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	CompanyListVO[]	否	返回数据

GET

/api/company/get/{id}

公司管理根据公司ID查询公司详情 OperationId: get_23

调用方法

GET /api/company/get/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResCompany	否

GET

/api/code-rule/page

编号规则查询编号规则 OperationId: page_12

调用方法

GET /api/code-rule/page

参数

名称	位置	必填	类型	说明	示例
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
merchantId	query	是	integer(int64)	商户号ID	123
type	query	否	string	类型	"PURCHASE_ORDER"
active	query	否	boolean	是否可用	true
otherType	query	否	string	其他类型

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResCodeRule	否

GET

/api/code-rule/generateDefCode

编号规则获取默认编号 OperationId: generateCode

调用方法

GET /api/code-rule/generateDefCode

参数

无

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	string	否	返回数据

GET

/api/code-rule/generateCode

编号规则根据规则获取编号(非批量，无缓存) OperationId: generateCode_1

调用方法

GET /api/code-rule/generateCode

参数

名称	位置	必填	类型	说明
merchantId	query	否	integer(int64)	商户号ID
codeRuleId	query	是	integer(int64)	编码规则ID
cache	query	是	integer(int64)	是否缓存《自增序列(根据各个MODEL中的seqCheck来拼接检查)》
companyId	query	否	integer(int64)	公司ID
goodsCategoryId	query	否	integer(int64)	商品分类ID
dynamicChar	query	否	string	动态字符

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	string	否	返回数据

GET

/api/calendar/sysList

日历管理获取系统日历列表 OperationId: sysList

调用方法

GET /api/calendar/sysList

参数

无

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysCalendar[]	否	返回数据

GET

/api/calendar/resList

日历管理获取商户日历 OperationId: resList

调用方法

GET /api/calendar/resList

参数

名称	位置	必填	类型	说明
merchantId	query	是	integer(int64)	商户ID
companyId	query	否	integer(int64)	公司ID
year	query	否	integer(int32)	年

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResCalendar[]	否	返回数据

GET

/api/attachment/list

附件管理查询附件 OperationId: list_15

调用方法

GET /api/attachment/list

参数

名称	位置	必填	类型	说明
originId	query	否	integer(int64)	源订单ID
originIdList	query	否	integer(int64)[]
originType	query	是	string	源订单类型
querySupplierUpload	query	否	boolean	查询附件创建人是否是供应商
createById	query	否	integer(int64)	创建人ID
originTypeSub	query	否	string	源订单子类型

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResAttachment[]	否	返回数据

GET

/api/application/querySysApplication

应用管理查询系统应用 OperationId: querySysApplication

调用方法

GET /api/application/querySysApplication

参数

名称	位置	必填	类型	说明	示例
merchantIndustry	query	否	string	商户行业	"COMPLEX"
companyType	query	否	string	公司类型	"STORE"
name	query	否	string	名称	"收银服务"
active	query	否	boolean	是否可用	true

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysApplication[]	否	返回数据

GET

/api/application/querySysApiPage/{sysApplicationId}

应用管理分页查询系统应用支持访问的接口 OperationId: querySysApplication_1

调用方法

GET /api/application/querySysApiPage/{sysApplicationId}

参数

名称	位置	必填	类型	说明	示例
sysApplicationId	path	是	integer(int64)	系统应用ID	1
page	query	是	integer(int32)	查询页码	0
size	query	是	integer(int32)	查询页行数	10
name	query	否	string	功能名称	"导出商品"

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysApi	否

GET

/api/application/list

应用管理查询应用列表 OperationId: list_16

调用方法

GET /api/application/list

参数

名称	位置	必填	类型	说明	示例
companyId	query	是	integer(int64)	公司ID	1
name	query	否	string	名称
code	query	否	string	编号

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResApplication[]	否	返回数据

GET

/api/application/get/{id}

应用管理根据ID查询详情 OperationId: get_24

调用方法

GET /api/application/get/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResApplication	否

DELETE

/api/tag/delete/{id}

标签管理删除标签 OperationId: delete

调用方法

DELETE /api/tag/delete/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	标签名称

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

DELETE

/api/role/delete/{id}

角色管理删除 OperationId: delete_1

调用方法

DELETE /api/role/delete/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

DELETE

/api/log/clearLog

日志管理清理日志 OperationId: clearLog

调用方法

DELETE /api/log/clearLog

参数

名称	位置	必填	类型	说明	示例
merchantId	query	是	integer(int64)	商户ID	1

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

DELETE

/api/email/template/delete/{id}

邮件模板管理删除 OperationId: delete_2

调用方法

DELETE /api/email/template/delete/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

DELETE

/api/attachment/delete/{id}

附件管理删除附件 OperationId: delete_3

调用方法

DELETE /api/attachment/delete/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

DELETE

/api/application/delete/{id}

应用管理删除 OperationId: delete_4

调用方法

DELETE /api/application/delete/{id}

参数

名称	位置	必填	类型	说明	示例
id	path	是	integer(int64)	ID	1

请求体

无

响应

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

模型定义

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

com.leadwaycloud.system.model.dto.PasswordRuleDTO$UpdateDTO

修改门店密码规则DTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
maxLength	integer(int32)	否	最大长度
minLength	integer(int32)	否	最小长度
neverExpiresAllowed	boolean	否	是否允许永不过期
numericDigitRequired	boolean	否	是否必须包含数字
specialCharactersAllowed	boolean	否	允许特殊符号
specialCharactersRequired	boolean	否	是否必须包含特殊符号
upperCaseCharactersRequired	boolean	否	必需包含大写字母
lockoutDuration	integer(int32)	否	自动签出时间(分)
validateDuration	integer(int32)	否	有效期(天)
expirationNotification	boolean	否	过期提醒
defaultPasswordValidateDuration	integer(int32)	否	默认密码有效期

com.leadwaycloud.core.model.RJava.lang.Boolean

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	boolean	否	返回数据

com.leadwaycloud.system.model.dto.UserDTO$UpdateDTO

修改用户DTO

名称	类型	必填	说明	示例
userName	string	否	登录名称
name	string	否	用户名称	"hyj"
language	string	否	系统语言	"zh_CN"
image	string	否	图片	"xxxxx"
status	string	否	状态	"ACTIVE"
readVersionInfo	boolean	否	是否已读更新版本信息
email	string	否	邮箱
sign	string	否	签名
password	string	否	默认密码
forceUpdatePassword	boolean	否	是否强制修改密码
mobilePhone	string	否	手机号	"131"
allowLoginChannel	boolean	否	允许登陆渠道(ERP:ERP_BACKEND,电商平台:ECOMMERCE_PLATFORM,供应商平台:SUPPLIER_PLATFORM)。如果有多个用,逗号隔开
userAuditStatus	string	否	用户审核状态
idaasId	string	否	idaas唯一ID
externalCode	string	否	外部编号

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.res.ResUser

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResUser	否

com.leadwaycloud.system.model.entity.crm.CrmAgent

代理商

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
status	string	是	状态
currencyId	integer(int64)	是	货币Id
birthday	string(date)	否	生日
sex	string	否	性别
note	string	否	备注
partnerId	integer(int64)	是	CRM对象ID
externalCode	string	否	外部编号
type	string	是	公司类型
merchantId	integer(int64)	是	商户ID
name	string	是	名称
image	string	否	图片
contactId	integer(int64)	否	地址ID
companyId	integer(int64)	否	公司ID
code	string	是	编号
financeInvoiceTitle	FinanceInvoiceTitle	否
crmAgentCompanyRelation	CrmAgentCompanyRelation	否
resCompany	ResCompany	否
qsupplierList	CrmSupplier[]	否

com.leadwaycloud.system.model.entity.crm.CrmAgentCompanyRelation

代理商公司与公司关联关系

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
companyId	integer(int64)	是	公司Id
agentId	integer(int64)	是	代理Id
status	string	是	状态

com.leadwaycloud.system.model.entity.crm.CrmCarrier

承运商

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
status	string	是	状态
currencyId	integer(int64)	是	货币Id
birthday	string(date)	否	生日
sex	string	否	生日
note	string	否	性别
partnerId	integer(int64)	是	CRM关系
externalCode	string	否	外部编号
type	string	是	公司类型
merchantId	integer(int64)	是	商户Id
name	string	是	名称
image	string	否	图片
contactId	integer(int64)	否	地址联系Id
companyId	integer(int64)	否	公司Id
code	string	是	编号
financeInvoiceTitle	FinanceInvoiceTitle	否
resCompany	ResCompany	否
qsupplierList	CrmSupplier[]	否

com.leadwaycloud.system.model.entity.crm.CrmSupplier

供应商

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
code	string	是	编号
birthday	string(date)	否	生日
sex	string	否	性别
note	string	否	备注
partnerId	integer(int64)	是	CRM对象ID
externalCode	string	否	外部编号
merchantId	integer(int64)	是	商户ID
status	string	是	状态
currencyId	integer(int64)	否	货币
type	string	是	公司类型
name	string	是	名称
image	string	否	图片
companyId	integer(int64)	否	公司ID
contactId	integer(int64)	否	地址
settlementMethod	string	否	供应商结算类型(默认结算类型)-爱达，维护供应商与公司绑定关系可重新设置结算类型
origin	string	否	来源
eligible	boolean	否	是否合格供应商-万航
shortName	string	否	简称
source	string	否	来源
sourceInfo	string	否	来源补充信息
distributionMode	string	否	经销模式
enterpriseType	string	否	企业类型
operatingStatus	string	否	经营状态
abnormalStatusReason	string	否	经营状态异常说明
version	string	否	版本号
establishmentDate	string(date)	否	成立日期
registeredCapital	number(double)	否	注册资本
legalRepresentative	string	否	法定代表人
registeredAddress	string	否	注册地址
extensionInfo	string	否	供应商额外属性
cooperationStatus	string	否	供应商合作状态-怡合达
epo	boolean	否	是否开启E订单-壳牌
restrictType	string	否	采购限制类型-壳牌
restrictQty	number(double)	否	采购限制数量-壳牌
orderExpiredClose	boolean	否	是否开启订单过期关闭-壳牌
orderValidity	integer(int32)	否	订单有效期(天)-壳牌

com.leadwaycloud.system.model.entity.finance.FinanceInvoiceTitle

发票抬头

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
headerName	string	否	抬头名称
address	string	否	地址
taxNo	string	否	税号
phone	string	否	电话
bank	string	否	开户银行
bankAccounts	string	否	银行账户
invoiceType	string	否	发票类型
recipient	string	否	收件人
mailAddress	string	否	邮寄地址
receivePhone	string	否	收件人手机或电话
partnerId	integer(int64)	是	CRM客户关系
merchantId	integer(int64)	是	商户ID
billingPeriod	integer(int32)	否	账期
status	string	否	状态
def	boolean	否	是否默认
externalCode	string	否	外部编号

com.leadwaycloud.system.model.entity.res.ResCompany

公司

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID
partnerId	integer(int64)	是	关系ID
code	string	是	公司编号（仅允许字母和数字）	"CD01"
otherCode	string	否	其他编号	"AAAA-01"
type	string	是	类型
status	string	是	状态
parentId	integer(int64)	否	上级公司ID
idChain	string	否	公司ID完整架构（上下级公司id用-连接）	"123-456"
slogan	string	否	公司标语
initConfig	boolean	否	是否已经初始化公司配置 true:已初始化 false:未初始化	false
name	string	是	名称
image	string	否	图片
contactId	integer(int64)	否	地址ID
foreignNames	string	否	其他国家名称JSON字符串
content	string	否	其他详情JSON字符串，可动态添加附件字段名
enName	string	否	发票名称
currencyId	integer(int64)	否	货币Id
partner	ResPartner	否
merchant	ResMerchant	否
contact	ResContact	否
currency	SysCurrency	否
crmAgentList	CrmAgent[]	否	代理商对象
crmCarrierList	CrmCarrier[]	否	承运商对象
financeInvoiceTitle	FinanceInvoiceTitle	否
companyGroupList	ResCompanyGroup[]	否	公司所属分组

com.leadwaycloud.system.model.entity.res.ResCompanyGroup

公司组

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID
name	string	是	名称
code	string	是	编号
description	string	否	描述
status	string	是	状态
type	string	否	类型
region	boolean	否	是否区域-壳牌
companyList	ResCompany[]	否	分组包含公司

com.leadwaycloud.system.model.entity.res.ResContact

地址联系关系

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
countryId	integer(int64)	否	国家ID
stateId	integer(int64)	否	省、直辖市ID
cityId	integer(int64)	否	城市ID
areaId	integer(int64)	否	区、县ID
streetId	integer(int64)	否	街道ID
address	string	否	详细地址
postcode	string	否	邮编
phone	string	否	电话
phoneExtension	string	否	电话-分机号
mobile	string	否	手机
fax	string	否	传真
faxExtension	string	否	传真-分机号
email	string	否	邮箱	"邮箱"
houseNumber	string	否	门牌号
latLon	string	否	经纬度

com.leadwaycloud.system.model.entity.res.ResMerchant

商户模型

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
code	string	是	编号
abbreviation	string	是	简称	"简称"
fullName	string	是	全称(用作初始化创建公司)	"公司全称"
status	string	是	商户状态
industry	string	是	行业
currencyId	integer(int64)	是	货币ID
email	string	是	联系邮箱(用作初始化创建账号)	"email"
phone	string	否	联系电话
address	string	否	地址
logo	string	否	logo	"logo"
currency	SysCurrency	否
merchantConfig	ResMerchantConfig	否

com.leadwaycloud.system.model.entity.res.ResMerchantConfig

商户配置

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID
expireDate	string(date)	是	过期时间
userCount	integer(int32)	是	用户数量
posCount	integer(int32)	是	机台数量
otherConfig	string	是	其他配置(json字符串)

com.leadwaycloud.system.model.entity.res.ResPartner

CRM关系

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
member	boolean	否	会员	false
supplier	boolean	否	供应商	false
customer	boolean	否	客户	false
employee	boolean	否	员工	false
franchisee	boolean	否	加盟商	false
company	boolean	否	公司	false
user	boolean	否	用户	false
carrier	boolean	否	承运商	false
agent	boolean	否	代理	false
producer	boolean	否	生产商	false
extensionInfo	string	否	扩展数据,设置客户资质信息(资质文件/签名/印章)等
customerPerson	boolean	否	客户联系人	false

com.leadwaycloud.system.model.entity.res.ResUser

用户模型

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
status	string	是	状态
userName	string	是	登录名称
language	string	是	语言	"zh_CN"
companyId	integer(int64)	否	公司ID
merchantId	integer(int64)	否	商户ID
readVersionInfo	boolean	否	是否已读更新版本信息	false
name	string	否	名称
image	string	否	图片
partnerId	integer(int64)	是	CRM对象ID
contactId	integer(int64)	否	地址联系ID
sign	string	否	用户签名
forceUpdatePassword	boolean	否	是否强制修改密码
idaasId	string	否	idaas唯一ID
allowLoginChannel	string	否	允许登陆渠道(ERP:ERP_BACKEND,电商平台:ECOMMERCE_PLATFORM,供应商平台:SUPPLIER_PLATFORM)。如果有多个用,逗号隔开
registerChannel	string	否	注册渠道(ERP:ERP_BACKEND,电商平台:ECOMMERCE_PLATFORM,IDaaS平台:IDAAS)
userAuditStatus	string	否	用户审核状态
externalCode	string	否	外部编号
contact	ResContact	否
company	ResCompany	否
merchant	ResMerchant	否
loginCompany	ResCompany	否
employeeDepartmentPositionList	string	否	员工-部门-职位集合

com.leadwaycloud.system.model.entity.sys.SysCurrency

货币模型

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
code	string	是	编号	"CNY"
name	string	是	名称	"人民币"
symbol	string	是	符号	"¥"
active	boolean	是	是否可用	true
calcRate	boolean	是	是否计算汇率	true
image	string	否	图片
rounding	integer(int32)	是	四舍五入精度
calcRateUnit	number(double)	否	汇率计算单位
roundingType	string	否	金额进舍规则:0=全部进位,1=全部舍位,2=四舍五入	"2"

com.leadwaycloud.system.shell.model.dto.UpdateUserPasswordDTO

修改用户密码DTO

名称	类型	必填	说明
password	string	是	密码
verificationCode	string	是	验证码
oldPassword	string	是	旧密码

com.leadwaycloud.system.model.dto.SystemUomDTO$UpdateDTO

编辑系统计量单位数据DTO

名称	类型	必填	说明	示例
code	string	否	编号	"1"
name	string	否	名称	"公斤"
symbol	string	否	符号	"kg"
ratio	number(double)	否	换算率
active	boolean	否	是否可用	true
shortName	string	否	简称
isoShortName	string	否	ISO名称

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.sys.SysUom

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysUom	否

com.leadwaycloud.system.model.entity.sys.SysUom

计量单位

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
code	string	是	计量单位code
name	string	是	计量单位名称
symbol	string	否	计量代号
active	boolean	是	是否是可用的
ratio	number(double)	否	换算率
shortName	string	否	简称
merchantId	integer(int64)	否	商户id
isoShortName	string	否	ISO名称

com.leadwaycloud.system.model.dto.TripLineDTO$UpdateDTO

编辑航线DTO

名称	类型	必填	说明	示例
name	string	否	航线名称
description	string	否	描述
images	string	否	图片
cruiseId	string	否	游船ID
code	string	否	编号
status	string	否	状态	"ACTIVE"
departureDate	string(date)	否	出发日期	"2021-10-11"
checkIn	LocalTime	否
cutOff	LocalTime	否
days	integer(int32)	否	航行天数
theme	string	否	航线主题
title	string	否	标题
remark	string	否	备注
voyageId	string	否	航次ID
hot	boolean	否	？？？
enable	boolean	否	？？？
settleable	boolean	否	？？？
settled	boolean	否	？？？
deleted	boolean	否	是否删除
line	string	否	明细对象
cruise	string	否	邮轮详情
routes	string	否	航线行程
weather	string	否	天气

java.time.LocalTime

结束进港时间

名称	类型	必填
hour	integer(int32)	否
minute	integer(int32)	否
second	integer(int32)	否
nano	integer(int32)	否

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.res.ResTripLine

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResTripLine	否

com.leadwaycloud.system.model.entity.res.ResTripLine

返回数据

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
images	string	否	图片
name	string	否	航线名称	"上海-冲绳-上海"
description	string	否	描述
code	string	是	航次编号	"NB04250102"
cruiseId	string	是	游船ID	"1624"
lineId	integer(int64)	否	序号	49
theme	string	否	航线主题
voyageId	string	否	航次ID
hot	boolean	是	？？？	false
enable	boolean	是	？？？	false
line	string	是	航线信息
cruise	string	是	邮轮详情
routes	string	是	航线行程
departureDate	string(date)	否	出发日期	"2021-01-01"
checkIn	LocalTime	否
cutOff	LocalTime	否
days	integer(int32)	否	航行天数
setteable	boolean	是	？？？	false
settled	boolean	是	？？？	false
deleted	boolean	是	删除表示	false
status	string	否	状态	"ACTIVE"
title	string	否	标题
remark	string	否	备注
merchantId	integer(int64)	是	商户ID
endDate	string(date)	否	结束日期	"2021-01-01"
weather	string	否	天气
version	integer(int64)	否	版本编号，自增
companyId	integer(int64)	否	公司id
closeTime	string(date-time)	否	航次关闭时间

com.leadwaycloud.system.model.dto.TagGroupDTO$UpdateDTO

编辑标签组DTO

名称	类型	必填	说明	示例
name	string	否	组名称
description	string	否	描述

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

com.leadwaycloud.system.model.dto.TagDTO$UpdateDTO

编辑标签DTO

名称	类型	必填	说明
name	string	否	名称
status	string	否	状态(ACTIVE:可用,DEACTIVATE:停用)
groupId	integer(int64)	否	组ID
description	string	否	描述

com.leadwaycloud.system.model.dto.SysPropertyDTO$UpdateDTO

编辑属性DTO

名称	类型	必填	说明
id	integer(int64)	否	ID
name	string	否	名称
group	string	否	分组
active	boolean	否	是否可用
val	string	否	属性值
description	string	否	描述
parentId	integer(int64)	否	上一级
sequence	integer(int32)	否	排序
hide	boolean	否	是否隐藏

com.leadwaycloud.system.model.dto.RoleDTO$UpdateDTO

修改角色DTO

名称	类型	必填	说明	示例
name	string	否	角色名称	"运维组"
description	string	否	描述	"公司ERP系统维护人员"
functionIdList	integer(int64)[]	否	功能ID集合
template	boolean	否	是否是模板	true
companyType	string	否	公司类型	"STORE"
appId	integer(int64)	否	sys_app.id

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.res.ResRole

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRole	否

com.leadwaycloud.system.model.entity.res.ResRole

用户角色

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
name	string	是	角色名称	"运维组"
description	string	否	描述	"公司ERP系统维护人员"
companyId	integer(int64)	是	公司
system	boolean	否	是否是系统创建角色	true
companyType	string	否	公司类型
template	boolean	是	是否是模板	true
templateId	integer(int64)	否	模版ID
idaasId	string	否	idaas唯一ID
appId	integer(int64)	否	sys_app.id
company	ResCompany	否
app	SysApp	否

com.leadwaycloud.system.model.entity.sys.SysApp

系统APP

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
name	string	是	名称
code	string	是	代号
image	string	否	图片

com.leadwaycloud.system.model.dto.SysReportGroupDTO$UpdateDTO

编辑报表分组DTO

名称	类型	必填	说明	示例
name	string	否	名称
status	string	否	状态

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.sys.SysReportGroup

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysReportGroup	否

com.leadwaycloud.system.model.entity.sys.SysReportGroup

报表分组表

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
name	string	是	名称
code	string	是	编号
status	string	是	状态
parentId	integer(int64)	否	父级ID
idChain	string	是	完整的组织结构
merchantId	integer(int64)	是	商户ID

com.leadwaycloud.system.model.dto.ReportDashboardDTO$UpdateDTO

编辑仪表板配置DTO

名称	类型	必填	说明	示例
modelId	integer(int64)	否	模型ID	608486975133453
userId	integer(int64)	否	用户ID	618708628295069
companyId	integer(int64)	否	公司ID	574533689957252
merchantId	integer(int64)	否	商户号ID	574533689957248
reportDashboardLayoutDTOList	SysReportDashboardLayoutDTO[]	否	仪表盘自定义布局配置集合
delReportDashboardLayoutList	integer(int64)[]	否	删除明细集合

com.leadwaycloud.system.model.dto.SysReportDashboardLayoutDTO

仪表板布局模型

名称	类型	必填	说明	示例
id	integer(int64)	否	ID
layout	string	是	布局	"xxxxxxxxxxx"
reportId	integer(int64)	是	报表ID	628765092806207

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.sys.SysReportDashboard

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysReportDashboard	否

com.leadwaycloud.system.model.entity.sys.SysApi

系统接口

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
open	boolean	是	是否是公开的	false
sort	integer(int64)	是	排序
name	string	是	接口名称
path	string	是	接口路径	"/lwc-cloud-erp-manager/sys/api/user/update-info"
method	string	是	请求方法	"PUT"
contentType	string	是	数据类型	"application/json"
description	string	否	接口描述
requestDemo	string	否	请求示例
requestParam	string	否	请求参数
responseDemo	string	是	响应数据模型
responseParam	string	是	响应参数
serviceCode	string	是	服务编号	"lwc-cloud-erp-manager"

com.leadwaycloud.system.model.entity.sys.SysReport

系统报表

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
modelId	integer(int64)	是	所属模块
name	string	是	名称	"xxx报表"
alias	string	否	别名	"xxx报表"
merchantIndustry	string	否	商户行业（com.leadwaycloud.manager.common.enums.MerchantIndustryEnum）	"COMPLEX"
companyType	string	否	公司类型（com.leadwaycloud.manager.common.enums.CompanyTypeEnum）	"STORE"
merchantId	integer(int64)	否	商户
type	string	是	类型	"EXCEL"
uesType	string	是	用途类型	"DASHBOARD"
active	boolean	是	是否可用	true
description	string	否	描述
reportViewConfig	SysReportViewConfig	否
sysReportGroupList	SysReportGroup[]	否	报表分类

com.leadwaycloud.system.model.entity.sys.SysReportDashboard

仪表盘自定义配置

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
modelId	integer(int64)	是	模型ID	608486975133453
userId	integer(int64)	是	用户ID	618708628295069
companyId	integer(int64)	是	公司ID	574533689957252
merchantId	integer(int64)	是	商户号ID	574533689957248
reportDashboardLayoutList	SysReportDashboardLayout[]	是	仪表盘自定义布局配置集合

com.leadwaycloud.system.model.entity.sys.SysReportDashboardLayout

仪表盘自定义布局配置

名称	类型	必填	说明	示例
id	integer(int64)	否
layout	string	是	布局	"xxxxxxxxxxx"
dashboardId	integer(int64)	是	仪表盘自定义配置ID
reportId	integer(int64)	是	报表ID
report	SysReport	否

com.leadwaycloud.system.model.entity.sys.SysReportViewConfig

报表展示配置

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
reportId	integer(int64)	是	报表ID
viewConfig	string	否	报表视图配置
sysApiId	integer(int64)	否	系统APIID
api	SysApi	否

com.leadwaycloud.system.model.dto.ReportDTO$BindReportRoleDTO

绑定报表权限DTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	574533689957252
reportId	integer(int64)	是	报表ID	628765092806207
userIdList	integer(int64)[]	否	用户ID集合
roleIdList	integer(int64)[]	否	角色ID集合

com.leadwaycloud.system.model.dto.ReportDTO$BindReportGroupDTO

绑定报表分类DTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
reportId	integer(int64)	是	报表ID
reportGroupIdList	integer(int64)[]	否	报表分类ID集合

com.leadwaycloud.system.model.dto.ReasonCodeDTO$UpdateDTO

编辑原因码DTO

名称	类型	必填	说明
code	string	否	编号
name	string	否	名称
typeId	integer(int64)	否	类型ID
externalCode	string	否	外部编号

com.leadwaycloud.system.model.dto.res.ResRatingDTO$UpdateDTO

修改合同评价DTO

名称	类型	必填	说明
id	integer(int64)	否	id
ratingTplId	integer(int64)	否	模版id
originType	string	否	源订单类型
originId	integer(int64)	否	源订单id
totalPenalty	number(double)	否	总扣分
status	string	否	状态
resIssuesRatingLineList	ResRatingLineDTO[]	否	修改问题评价明细集合
delResIssuesRatingLineList	integer(int64)[]	否	删除问题评价明细集合

com.leadwaycloud.system.model.dto.res.ResRatingLineDTO

问题评价明细

名称	类型	必填	说明
id	integer(int64)	否	id
ratingId	integer(int64)	否	问题评价表id
ratingTopicId	integer(int64)	否	问题评价题库表id
ratingUserId	integer(int64)	否	评价人
penalty	number(double)	否	扣分
note	string	否	备注
status	string	否	问题内容
issuesDescription	string	否	问题描述
issuesQty	integer(int32)	否	问题数量

com.leadwaycloud.system.model.dto.res.ResRatingTopicDTO$UpdateDTO

修改合同评价题库DTO

名称	类型	必填	说明
id	integer(int64)	否	id
ratingCategoryId	integer(int64)	否	评价分类id
content	string	否	内容
totalScore	integer(int64)	否	总分
merchantId	integer(int64)	否	商户id
status	string	否	状态

com.leadwaycloud.system.model.dto.res.ResRatingTemplateDTO$UpdateDTO

修改合同评价模版DTO

名称	类型	必填	说明
id	integer(int64)	是	id
type	string	否	模版类型(合同/其他)
totalPenalty	number(double)	否	总扣分
note	string	否	备注
status	string	否	问题内容
name	string	否	名称
ratingTopicIdList	integer(int64)[]	否	题库ID集合

com.leadwaycloud.system.model.dto.res.ResRatingCategoryDTO$UpdateDTO

修改合同评价分类DTO

名称	类型	必填	说明
id	integer(int64)	否	id
name	string	否	名称
code	string	否	编号
parentId	integer(int64)	否	上一级id
merchantId	integer(int64)	否	商户id
idChain	string	否	完整的组织结构
status	string	否	状态
ratingUserId	integer(int64)	否	评价人ID

com.leadwaycloud.system.model.dto.LoginConfigDTO$UpdateDTO

编辑登录配置DTO

名称	类型	必填	说明	示例
enableDualVerify	boolean	否	是否开启双重验证（密码+验证码）
enableEmailVerify	boolean	否	是否开启邮件验证
enableShortMessageVerify	boolean	否	是否开启短信验证
loginErrorCountCheck	boolean	否	登录错误次数校验
allowErrorCount	integer(int32)	否	允许错误次数
lockTime	integer(int32)	否	锁定时间
lockTimeUom	string	否	锁定时间单位（分、时、天）	"DAY"

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.res.ResLoginConfig

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResLoginConfig	否

com.leadwaycloud.system.model.entity.res.ResLoginConfig

登录配置

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID
enableDualVerify	boolean	是	是否开启双重验证（密码+验证码）
enableEmailVerify	boolean	是	是否开启邮件验证
enableShortMessageVerify	boolean	是	是否开启短信验证
loginErrorCountCheck	boolean	是	登录错误次数校验
allowErrorCount	integer(int32)	否	允许错误次数
lockTime	integer(int32)	否	锁定时间
lockTimeUom	string	否	锁定时间单位（分、时、天）

com.leadwaycloud.system.model.dto.login.ForgotPasswordDTO

忘记密码DTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
userName	string	否	用户名
mobilePhone	string	否	手机号
captcha	string	是	验证码
password	string	是	需要修改的密码

com.leadwaycloud.system.model.dto.login.AccountActivationDTO

账号激活DTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
userName	string	否	用户名
captcha	string	是	验证码
password	string	是	需要初始化的密码

com.leadwaycloud.system.model.dto.LogClearConfigDTO$UpdateDTO

编辑日志清理配置DTO

名称	类型	必填	说明	示例
reserveTime	integer(int32)	否	保留时间（单位：月）	1
status	string	否	状态（ACTIVE, DEACTIVATE）
host	string	否	IP地址

com.leadwaycloud.system.model.dto.TranslationDTO$UpdateDTO

修改商户字典DTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户
translationId	integer(int64)	是	语言
value	string	是	翻译

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.res.ResTranslation

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResTranslation	否

com.leadwaycloud.system.model.entity.res.ResTranslation

多语言字典

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
langId	integer(int64)	是	语言
key	string	否	翻译字典Key
value	string	否	翻译字典
comments	string	否	备注	"zh_CN"
application	string	否	应用名	"crm"
module	string	否	模块	"memberhsip"
industry	string	是	行业

com.leadwaycloud.system.model.dto.LangDTO$UpdateDTO

修改商户语言设置DTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户
langId	integer(int64)	是	语言
direction	string	是	排序方向	"ltr"
thousandsSep	string	是	千分位符号
translatable	boolean	是	是否有翻译	false
dateFormat	string	是	日期格式	"%Y年%m月%d日"
timeFormat	string	是	时间格式	"%H时%M分%S秒"
decimalPoint	string	是	小数点符号	"."
weekStart	integer(int32)	是	每周开始天

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.res.ResLang

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResLang	否

com.leadwaycloud.system.model.entity.res.ResLang

多语言参数

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
name	string	是	名称
code	string	是	语言编码	"zh_CN"
direction	string	是	排序方向	"ltr"
thousandsSep	string	否	千分位符号
translatable	boolean	否	是否有翻译	false
dateFormat	string	是	日期格式	"%Y年%m月%d日"
timeFormat	string	是	时间格式	"%H时%M分%S秒"
decimalPoint	string	是	小数点符号	"."
active	boolean	否	是否可用	true
isoCode	string	否	国际标准编码符号	"zh_CN"
weekStart	integer(int32)	是	每周开始天

com.leadwaycloud.system.model.dto.TagDTO$AssociatedTagDTO

关联标签模型

名称	类型	必填	说明	示例
tagIdList	integer(int64)[]	否	标签ID
associateType	string	是	关联类型

com.leadwaycloud.system.model.dto.res.ResIssuesDTO$UpdateDTO

修改问题DTO

名称	类型	必填	说明
id	integer(int64)	是	id
title	string	否	问题标题
content	string	否	问题内容
originId	integer(int64)	是	业务ID
originType	string	否	合同/其他
status	string	否	状态
startDate	string(date)	否	开始日期
endDate	string(date)	否	结束日期
assignPersonIdList	integer(int64)[]	否	指派人ID集合
priority	string	否	优先级
associatedTagDTO	TagDTO$AssociatedTagDTO	否
model	string	否	类型
file	integer(int64)	否	附件
departmentIdList	integer(int64)[]	否	部门集合

com.leadwaycloud.system.model.dto.res.ResIssuesCommentDTO$UpdateDTO

修改问题评论DTO

名称	类型	必填	说明
id	integer(int64)	是	评论ID
content	string	是	问题内容
status	string	是	问题内容
operatorId	integer(int64)	否	操作人ID

com.leadwaycloud.system.model.dto.idaas.IdaasConfigDTO

Idaas配置DTO

名称	类型	必填	说明
id	integer(int64)	否	ID
appId	string	是	应用ID
jwkUrl	string	是	JWK URL地址
jwkJson	string	否	JWK JSON内容(可选,用于离线验证)
encryptKey	string	否	加密密钥
active	boolean	否	是否可用

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.res.ResIdaasConfig

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResIdaasConfig	否

com.leadwaycloud.system.model.entity.res.ResIdaasConfig

Idaas配置

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID
appId	string	是	应用ID
jwkUrl	string	是	JWK URL地址
jwkJson	string	否	JWK JSON内容(可选,用于离线验证)
encryptKey	string	否	加密密钥
active	boolean	是	是否可用

com.leadwaycloud.system.model.dto.ExternalDataMappingDTO$AddDTO

添加外部数据映射DTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
companyId	integer(int64)	是	公司ID
erpCode	string	否	ERP编号
externalCode	string	是	外部编号
description	string	是	描述
other	string	否	其他字段
type	string	是	类型

com.leadwaycloud.system.model.dto.ExternalDataMappingDTO$BatchUpdateDTO

批量编辑外部数据映射DTO

名称	类型	必填	说明
addDTOList	ExternalDataMappingDTO$AddDTO[]	否	添加映射对象集合
updateDTOList	ExternalDataMappingDTO$UpdateDTO[]	否	编辑映射对象集合
delIdList	integer(int64)[]	否	删除映射对象ID集合

com.leadwaycloud.system.model.dto.ExternalDataMappingDTO$UpdateDTO

编辑外部数据映射DTO

名称	类型	必填	说明
id	integer(int64)	是	ID
erpCode	string	否	ERP编号
externalCode	string	否	外部编号
description	string	否	描述
other	string	否	其他字段

com.leadwaycloud.system.model.dto.ExternalAppConfigDTO$UpdateDTO

编辑外部应用配置DTO

名称	类型	必填	说明
businessDate	string(date)	否	营业日
shiftNo	integer(int32)	否	班次
insertCoins	string	否	投币
cashOut	string	否	现金出
customersLeaveWithoutPaying	string	否	跑单
oilGunTest	string	否	油枪测试
syncNonOilStock	boolean	否	是否同步非油库存
isAutoShelf	boolean	否	是否自动上架

com.leadwaycloud.system.shell.model.dto.EndOfDayConfigDTO$ResFuelInventorySummaryConfigDTO

油品帐存差异配置DTO

名称	类型	必填	说明
id	integer(int64)	否	id
goodsId	integer(int64)	否	商品ID
minQty	number(double)	否	差异最小值
maxQty	number(double)	否	差异最大值

com.leadwaycloud.system.shell.model.dto.EndOfDayConfigDTO$UpdateDTO

编辑日结配置DTO

名称	类型	必填	说明
startBusinessDate	string(date)	是	初始营业日
autoEndOfDay	boolean	否	开启自动日结
dryNegativeStockCheck	boolean	否	开启非油负库存校验
fuelInventorySummary	boolean	否	开启油品帐存差异校验
fuelInventorySummaryConfigDTOList	EndOfDayConfigDTO$ResFuelInventorySummaryConfigDTO[]	否	油品帐存差异配置明细
delFuelInventorySummaryConfigIdList	integer(int64)[]	否	删除油品帐存差异配置明细ID

com.leadwaycloud.system.model.dto.EmailTemplateDTO$UpdateDTO

编辑邮件模板DTO

名称	类型	必填	说明
title	string	否	标题
status	string	否	状态
content	string	否	内容
ccRole	string	否	抄送角色
ccUser	string	否	抄送用户ID集合
addresseeUser	string	否	收件用户ID集合
notifySupplier	boolean	否	通知供应商

com.leadwaycloud.system.model.dto.DynamicTaskDTO

动态任务模型

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
merchantId	integer(int64)	是	商户ID	1
name	string	是	名称
code	string	是	代码
cron	string	是	cron表达式
issuedSystem	string	是	推送系统	"1"
issuedType	string	是	推送类型	"1"
isActive	boolean	是	是否启用
lastTime	string(date-time)	否	最后推送时间
taskConfig	string	是	任务配置

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.res.ResDynamicTask

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResDynamicTask	否

com.leadwaycloud.system.model.entity.res.ResDynamicTask

系统动态任务

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
companyId	integer(int64)	否	公司ID
merchantId	integer(int64)	是	商户ID
name	string	否	名称
code	string	是	代号
cron	string	是	cron表达式
issuedSystem	string	是	推送系统
issuedType	string	是	推送类型
isActive	boolean	是	是否启用
lastTime	string(date-time)	否	最后推送时间
taskName	string	否	任务Key
taskConfig	string	否	任务配置

com.leadwaycloud.system.model.dto.CurrencyDTO$UpdateDTO

修改货币数据DTO

名称	类型	必填	说明	示例
code	string	否	编号	"CNY"
name	string	否	名称	"人民币"
symbol	string	否	符号	"¥"
image	string	否	图片
rounding	integer(int32)	否	四舍五入精度
active	boolean	否	是否可用	true
calcRate	boolean	否	是否计算汇率	true
calcRateUnit	number(double)	否	汇率计算单位
roundingType	string	否	金额进舍规则:0=全部进位,1=全部舍位,2=四舍五入	"2"

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.sys.SysCurrency

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysCurrency	否

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

联系地址修改DTO

名称	类型	必填	说明	示例
countryId	integer(int64)	否	国家ID	1
stateId	integer(int64)	否	省、直辖市ID	1
cityId	integer(int64)	否	城市ID	1
areaId	integer(int64)	否	区、县ID	1
streetId	integer(int64)	否	街道ID	1
address	string	否	详细地址	"1"
postcode	string	否	邮编	"1"
phone	string	否	电话	"1"
fax	string	否	传真	"1"
email	string	否	邮箱	"邮箱"
mobile	string	否	手机	"1"

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.res.ResContact

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResContact	否

com.leadwaycloud.system.model.dto.CompanyGroupDTO$UpdateDTO

编辑公司组DTO

名称	类型	必填	说明
status	string	否	状态
name	string	否	名称
description	string	否	描述
type	string	否	类型

com.leadwaycloud.system.model.dto.CompanyDTO$UpdateDTO

修改公司DTO

名称	类型	必填	说明	示例
name	string	否	公司名称	"立威云"
image	string	否	公司LOGO	"xxx.logo"
slogan	string	否	公司标语	"111"
status	string	否	状态	"IN_OPERATION"
otherCode	string	否	其他编号	"AAAA-01"
updateContactDTO	ContactDTO$UpdateDTO	否
updateFinanceInvoiceTitleDTO	FinanceInvoiceTitleDTO$UpdateDTO	否

com.leadwaycloud.system.model.dto.FinanceInvoiceTitleDTO$UpdateDTO

编辑发票抬头DTO

名称	类型	必填	说明
headerName	string	否	抬头名称
address	string	否	地址
taxNo	string	否	税号
phone	string	否	电话
bank	string	否	开户银行
bankAccounts	string	否	银行账户
recipient	string	否	收件人
mailAddress	string	否	邮寄地址
receivePhone	string	否	收件人手机或电话
billingPeriod	integer(int32)	否	账期

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.res.ResCompany

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResCompany	否

com.leadwaycloud.system.model.dto.ResCalendarDTO$UpdateDTO

编辑商户日历DTO

名称	类型	必填	说明
id	integer(int64)	是	主键ID
merchantId	integer(int64)	是	商户ID
companyId	integer(int64)	否	公司ID
sysCalendarId	integer(int64)	是	系统日历ID
year	integer(int32)	是	年
month	integer(int32)	是	月
day	integer(int32)	是	日
holiday	string	否	商户规定节假日，如果未设定则按照国家法定节假日执行

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.res.ResApplication

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResApplication	否

com.leadwaycloud.system.model.entity.res.ResApplication

返回数据

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
companyId	integer(int64)	是	公司ID
sysApplicationId	integer(int64)	是	系统应用ID
code	string	是	应用code(系统唯一)
publicKey	string	是	应用公钥
privateKey	string	是	应用私钥
linkUserId	integer(int64)	是	关联用户ID
token	string	否	应用token
name	string	否	名称
linkUser	ResUser	否

com.leadwaycloud.system.model.dto.UserPersonalCenterDTO

修改个人信息DTO

名称	类型	必填	说明
name	string	是	用户名称
language	string	是	系统语言
image	string	是	图片

com.leadwaycloud.system.model.dto.register.RegisterMallUserDTO

注册商城用户DTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
customerName	string	是	客户名称
contactPersonName	string	是	联系人名称
userName	string	是	用户名
nickName	string	是	昵称
mobilePhone	string	是	手机号
captcha	string	是	验证码

com.leadwaycloud.system.plug.poi.model.dto.ExportDTOJava.lang.Object

公共导出模型

名称	类型	必填	说明
reportColumnList	ReportColumnDTO[]	是	需导出参数集合
queryDTO	object	是	搜索条件对象DTO
fileName	string	是	导出文件名

com.leadwaycloud.system.plug.poi.model.dto.ReportColumnDTO

选择导出列模型

名称	类型	必填	说明
key	string	否	导出列名称
name	string	否	导出列展示名称
width	number(double)	否	列宽
height	number(double)	否	列高
type	integer(int32)	否	导出类型 1 是文本 2 是图片,3 是函数,10 是数字默认是文本
exportImageType	integer(int32)	否	图片的类型,1是文件,2是数据库
columnList	ReportColumnDTO[]	否	子集

com.leadwaycloud.system.model.dto.UserDTO$AddDTO

添加用户DTO

名称	类型	必填	说明	示例
email	string	是	邮箱
name	string	否	用户名称	"hyj"
language	string	是	系统语言	"zh_CN"
image	string	否	图片	"xxxxx"
companyId	integer(int64)	是	公司ID	1
merchantId	integer(int64)	是	商户ID	1
userName	string	是	账号
password	string	否	默认密码
status	string	否	状态(INACTIVATED:未激活；ACTIVE:激活)
sign	string	否	签名
forceUpdatePassword	boolean	否	是否强制修改密码
mobilePhone	string	否	手机号	"131"
partnerId	integer(int64)	否	CRM关系ID
allowLoginChannel	boolean	否	允许登陆渠道(ERP:ERP_BACKEND,电商平台:ECOMMERCE_PLATFORM,供应商平台:SUPPLIER_PLATFORM)。如果有多个用,逗号隔开
registerChannel	boolean	否	注册渠道(ERP:ERP_BACKEND,电商前台:ECOMMERCE_PLATFORM,IDaaS平台:IDAAS)
idaasId	string	否	idaas唯一ID
userAuditStatus	string	否	用户审核状态
externalCode	string	否	外部编号

com.leadwaycloud.system.model.dto.SystemUomDTO$QueryDTO

分页查询计量单位数据DTO

名称	类型	必填	说明	示例
code	string	否	编号	"1"
name	string	否	名称	"公斤"
symbol	string	否	符号	"kg"
shortName	string	否	简称
merchantId	integer(int64)	否	商户ID
active	boolean	否	是否是可用的	true
isoShortName	string	否	ISO名称

com.leadwaycloud.system.plug.poi.model.dto.ExportDTOCom.leadwaycloud.system.model.dto.SystemUomDTO$QueryDTO

公共导出模型

名称	类型	必填	说明
reportColumnList	ReportColumnDTO[]	是	需导出参数集合
queryDTO	SystemUomDTO$QueryDTO	是
fileName	string	是	导出文件名

com.leadwaycloud.system.model.dto.SystemUomDTO$AddDTO

添加计量单位数据DTO

名称	类型	必填	说明	示例
code	string	是	编号	"1"
name	string	是	名称	"公斤"
symbol	string	是	符号	"kg"
ratio	number(double)	否	换算率
shortName	string	否	简称
merchantId	integer(int64)	是	商户ID
isoShortName	string	否	ISO名称

com.leadwaycloud.system.model.dto.SyncTripLineDTO

名称	类型	必填	说明
id	integer(int64)	是	ID
images	string	否	图片
cruiseId	string	是	游船ID
lineId	integer(int64)	是	序号
code	string	是	编号
departureDate	string	是	出发日期
checkIn	string	是	开始进港时间
cutOff	string	是	结束进港时间
days	integer(int32)	是	航行天数
theme	string	否	航线主题
title	string	否	标题
remark	string	否	备注
voyageId	string	否	航次ID
hot	boolean	是	？？？
enable	boolean	是	？？？
settleable	boolean	是	？？？
settled	boolean	是	？？？
deleted	boolean	是	是否删除
createdAt	string	是	创建时间
updatedAt	string	是	编辑时间
line	object	是	明细对象
cruise	object	是	邮轮详情
routes	object[]	是	航线行程

com.leadwaycloud.system.model.dto.TripLineDTO$AddDTO

新增航线DTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID
name	string	是	航线名称
description	string	否	描述
images	string	否	图片
cruiseId	string	是	游船ID
code	string	是	编号
departureDate	string(date)	是	出发日期	"2021-10-11"
checkIn	LocalTime	是
cutOff	LocalTime	是
days	integer(int32)	是	航行天数
theme	string	否	航线主题
title	string	否	标题
remark	string	否	备注
voyageId	string	否	航次ID
hot	boolean	否	？？？
enable	boolean	否	？？？
settleable	boolean	否	？？？
settled	boolean	否	？？？
deleted	boolean	否	是否删除
line	string	否	明细对象
cruise	string	否	邮轮详情
routes	string	否	航线行程
weather	string	否	天气

com.leadwaycloud.system.model.dto.AssociatedTagDTO

关联标签模型

名称	类型	必填	说明	示例
tagIdList	integer(int64)[]	否	标签ID
associateType	string	是	关联类型
associateId	integer(int64)	是	关联ID	1
disassociateTagIdList	integer(int64)[]	否	取消关联标签ID

com.leadwaycloud.system.model.dto.TagDTO$AddDTO

添加标签DTO

名称	类型	必填	说明	示例
name	string	是	标签名称
merchantId	integer(int64)	是	商户ID	1
groupId	integer(int64)	否	组ID	1
type	string	否	类型	"1"
description	string	否	描述

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	integer(int64)	否	返回数据

com.leadwaycloud.system.model.dto.TagGroupDTO$AddDTO

添加标签组DTO

名称	类型	必填	说明	示例
name	string	是	组名称
merchantId	integer(int64)	是	商户ID	1
description	string	否	描述
groupId	integer(int64)	否	组ID

com.leadwaycloud.system.model.dto.SysPropertyDTO$AddDTO

添加属性DTO

名称	类型	必填	说明
name	string	是	名称
group	string	是	分组
val	string	是	属性值
description	string	否	描述
parentId	integer(int64)	否	上一级
sequence	integer(int32)	是	排序
hide	boolean	否	是否隐藏
merchantId	integer(int64)	是	商户ID
active	boolean	否	状态

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.sys.SysProperty

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysProperty[]	否	返回数据

com.leadwaycloud.system.model.entity.sys.SysProperty

系统公用属性模版

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
name	string	是	名称
group	string	是	分组
active	boolean	是	是否可用
val	string	是	属性值
description	string	否	描述
parentId	integer(int64)	否	上一级
sequence	integer(int32)	是	排序
hide	boolean	是	是否隐藏
merchantId	integer(int64)	否	商户ID（系统属性默认为1, 商户属性为对应商户ID）

com.leadwaycloud.system.shell.model.dto.ShiftReconciliationConfigDTO$AddDTO

添加班结配置DTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
companyId	integer(int64)	是	公司ID
config	string	是	配置

com.leadwaycloud.system.model.dto.ExtendsTemplateRoleDTO

模版角色下发DTO

名称	类型	必填	说明	示例
companyId	integer(int64)[]	是	下发公司ID
userIdList	integer(int64)[]	是	用户ID集合

com.leadwaycloud.system.model.dto.RoleDTO$AddDTO

添加角色DTO

名称	类型	必填	说明	示例
name	string	是	角色名称	"运维组"
description	string	否	描述	"公司ERP系统维护人员"
companyId	integer(int64)	是	公司ID	1
functionIdList	integer(int64)[]	否	角色包含的功能
template	boolean	否	是否是模板	true
companyType	string	否	公司类型	"STORE"
templateId	integer(int64)	否	模版ID	1
idaasId	string	否	idaas唯一ID
appId	integer(int64)	否	sys_app.id

com.leadwaycloud.system.model.dto.SysReportGroupDTO$AddDTO

添加报表分组DTO

名称	类型	必填	说明
name	string	是	名称
code	string	是	编号
parentId	integer(int64)	否	父级ID
merchantId	integer(int64)	是	商户ID

com.leadwaycloud.system.model.dto.ReportDashboardDTO$AddDTO

添加仪表板配置DTO

名称	类型	必填	说明	示例
modelId	integer(int64)	是	模型ID	608486975133453
userId	integer(int64)	是	用户ID	618708628295069
companyId	integer(int64)	是	公司ID	574533689957252
merchantId	integer(int64)	是	商户号ID	574533689957248
reportDashboardLayoutDTOList	SysReportDashboardLayoutDTO[]	是	仪表盘自定义布局配置集合

com.leadwaycloud.system.model.dto.ReasonCodeDTO$AddDTO

添加原因码DTO

名称	类型	必填	说明	示例
code	string	是	原因码
merchantId	integer(int64)	是	商户ID	1
name	string	是	名称
typeId	integer(int64)	是	类型ID
externalCode	string	否	外部编号

com.leadwaycloud.system.model.dto.ReasonCodeTypeDTO$AddDTO

添加原因码组DTO

名称	类型	必填	说明	示例
name	string	是	名称
merchantId	integer(int64)	是	商户ID	1
orderType	string	是	订单类型

com.leadwaycloud.system.model.dto.res.ResRatingTopicDTO$AddDTO

添加合同评价题库DTO

名称	类型	必填	说明
ratingCategoryId	integer(int64)	否	评价分类id
content	string	否	内容
totalScore	integer(int64)	否	总分
merchantId	integer(int64)	否	商户id
status	string	否	状态

com.leadwaycloud.system.model.dto.res.ResRatingTemplateDTO$AddDTO

添加合同评价模版DTO

名称	类型	必填	说明
type	string	否	模版类型(合同/其他)
totalPenalty	number(double)	否	总扣分
note	string	否	备注
name	string	否	名称
merchantId	integer(int64)	是	商户ID
companyId	integer(int64)	是	公司Id
ratingTopicIdList	integer(int64)[]	否	题库ID集合

com.leadwaycloud.system.model.dto.res.ResRatingCategoryDTO$AddDTO

添加合同评价分类DTO

名称	类型	必填	说明
name	string	是	名称
code	string	是	编号
parentId	integer(int64)	否	上一级id
merchantId	integer(int64)	是	商户id
status	string	否	状态
ratingUserId	integer(int64)	否	评价人ID

com.leadwaycloud.system.model.dto.res.ResRatingDTO$AddDTO

添加合同评价DTO

名称	类型	必填	说明
ratingTplId	integer(int64)	否	模版id
originType	string	否	源订单类型
originId	integer(int64)	否	源订单id
totalPenalty	number(double)	否	总扣分
status	string	否	状态
resIssuesRatingLineList	ResRatingLineDTO[]	否	问题评价明细集合

com.leadwaycloud.system.model.dto.DownloadExportTemplateDTO

模版下载DTO

名称	类型	必填	说明
orderType	string	是	导出订单类型
columnDTOList	DownloadExportTemplateDTO$ColumnDTO[]	否	导出列对象集合
titleDTOList	DownloadExportTemplateDTO$TitleDTO[]	否	动态标题列集合
merchantId	integer(int64)	否	商户ID

com.leadwaycloud.system.model.dto.DownloadExportTemplateDTO$ColumnDTO

模版列导出DTO

名称	类型	必填	说明
key	string	否	导出列名称
name	string	否	导出列展示名称
isExportColumn	boolean	否	是否导出该列

com.leadwaycloud.system.model.dto.DownloadExportTemplateDTO$TitleDTO

动态模版导出标题

名称	类型	必填	说明	示例
key	string	否	导出列名称
name	string	否	导出列展示名称

com.leadwaycloud.system.model.dto.ExcelTemplateConfigDTO$AddDTO

添加Excel模版导出列配置DTO

名称	类型	必填	说明
type	string	是	模版类型
configData	string	是	配置内容
merchantId	integer(int64)	是	商户ID
noteData	string	否	备注内容
tempData	string	否	模拟数据内容
dynamicTitleData	string	否	动态标题内容
version	string	否	版本内容

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.sys.SysDataImportTemplate

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysDataImportTemplate	否

com.leadwaycloud.system.model.entity.sys.SysDataImportTemplate

模版下载配置表

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
type	string	是	模版类型
configData	string	否	配置内容
merchantId	integer(int64)	否	商户ID
noteData	string	否	配置内容
tempData	string	否	配置内容
dynamicTitleData	string	否	配置内容
version	string	否	配置内容
def	boolean	否	是否系统默认模版

com.leadwaycloud.system.model.dto.LoginConfigDTO$AddDTO

添加登录配置DTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
enableDualVerify	boolean	是	是否开启双重验证（密码+验证码）
enableEmailVerify	boolean	是	是否开启邮件验证
enableShortMessageVerify	boolean	是	是否开启短信验证
loginErrorCountCheck	boolean	是	登录错误次数校验
allowErrorCount	integer(int32)	否	允许错误次数
lockTime	integer(int32)	否	锁定时间
lockTimeUom	string	否	锁定时间单位（分、时、天）	"DAY"

com.leadwaycloud.system.model.dto.login.UserLoginByUserNameDTO

用户名+密码登陆DTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
loginCompanyId	integer(int64)	否	登陆公司ID
userName	string	是	用户名
password	string	是	密码
loginChannel	string	是	登陆渠道

com.leadwaycloud.system.model.dto.login.UserLoginByTwoFactorAuthDTO

双因素登陆DTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
userId	integer(int64)	是	用户ID
captcha	string	是	验证码
loginChannel	string	是	登陆渠道

com.leadwaycloud.system.shell.model.dto.GetTokenDTO

获取-刷新tokenDTO

名称	类型	必填	说明
grant_type	string	是	授权类型 (password: 通过账号密码获取, refresh_token：通过刷新token获取)
username	string	是	账号
password	string	是	密码
refresh_token	string	是	刷新token

com.leadwaycloud.system.model.dto.login.UserLoginByMobilePhoneDTO

手机号+验证码登陆DTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
mobilePhone	string	是	手机号
captcha	string	是	验证码
loginChannel	string	是	登陆渠道

com.leadwaycloud.system.model.dto.login.UserLoginByEmailDTO

邮箱+验证码登陆DTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
email	string	是	邮箱
captcha	string	是	验证码
loginChannel	string	是	登陆渠道

com.leadwaycloud.system.model.dto.UserManageLogDTO$QueryDTO

查询用户管理日志DTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户ID
companyId	integer(int64)	否	公司ID
updateUserName	string	否	编辑用户账号
startTime	string(date-time)	否	开始时间
endTime	string(date-time)	否	结束时间

com.leadwaycloud.system.plug.poi.model.dto.ExportDTOCom.leadwaycloud.system.model.dto.UserManageLogDTO$QueryDTO

公共导出模型

名称	类型	必填	说明
reportColumnList	ReportColumnDTO[]	是	需导出参数集合
queryDTO	UserManageLogDTO$QueryDTO	是
fileName	string	是	导出文件名

com.leadwaycloud.core.model.R

请求结果

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

com.leadwaycloud.system.model.dto.UserManageLogDTO$AddDTO

添加用户管理日志DTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户ID
companyId	integer(int64)	否	公司ID
updateUserId	integer(int64)	是	编辑用户ID
updateUserName	string	是	编辑用户账号
functionId	integer(int64)	是	菜单ID
functionName	string	是	菜单名称
createBy	integer(int64)	是	创建人ID
createByName	string	是	创建人名称
responseContent	R	是

com.leadwaycloud.system.model.dto.LoginLogDTO$QueryDTO

登录日志DTO

名称	类型	必填	说明
userName	string	否	用户账号
userId	integer(int64)	否	用户ID
startTime	string(date-time)	否	开始时间
endTime	string(date-time)	否	结束时间

com.leadwaycloud.system.plug.poi.model.dto.ExportDTOCom.leadwaycloud.system.model.dto.LoginLogDTO$QueryDTO

公共导出模型

名称	类型	必填	说明
reportColumnList	ReportColumnDTO[]	是	需导出参数集合
queryDTO	LoginLogDTO$QueryDTO	是
fileName	string	是	导出文件名

com.leadwaycloud.system.model.dto.UserLoginLogDTO

用户登陆日志DTO

名称	类型	必填	说明
type	string	否	orientation
orientation	string	否	orientation
os	string	否	操作系统
merchantId	integer(int64)	是	商户ID
userId	integer(int64)	否	用户id
userName	string	否	用户账号
responseContent	string	否	请求结果

com.leadwaycloud.system.model.dto.GatewaySessionRecordDTO

网关请求记录DTO

名称	类型	必填	说明
companyId	integer(int64)	否	公司ID
functionId	integer(int64)	否	功能ID
userId	integer(int64)	否	用户ID
appId	integer(int64)	否	sys_app.id
startTime	string(date-time)	否	开始时间
endTime	string(date-time)	否	结束时间

com.leadwaycloud.system.plug.poi.model.dto.ExportDTOCom.leadwaycloud.system.model.dto.GatewaySessionRecordDTO

公共导出模型

名称	类型	必填	说明
reportColumnList	ReportColumnDTO[]	是	需导出参数集合
queryDTO	GatewaySessionRecordDTO	是
fileName	string	是	导出文件名

com.leadwaycloud.system.model.dto.LogClearConfigDTO$AddDTO

添加日志清理配置DTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
reserveTime	integer(int32)	是	保留时间（单位：月）	1
status	string	是	状态（ACTIVE, DEACTIVATE）
host	string	否	IP地址(当status=ACTIVE时需要)

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.res.ResLogClearConfig

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResLogClearConfig	否

com.leadwaycloud.system.model.entity.res.ResLogClearConfig

日志清理配置

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID
reserveTime	integer(int32)	是	保留时间（单位：月）
status	string	否	状态（ACTIVE, DEACTIVATE）	"ACTIVE"

com.leadwaycloud.system.model.dto.TranslationDTO$AddDTO

添加翻译字典DTO

名称	类型	必填	说明	示例
langId	integer(int64)	是	语言ID	1
industry	string	是	行业	"COMPLEX_RETAIL"
application	string	是	应用	"crm"
module	string	是	模块	"common"
key	string	是	字典key	"K222u3u38"
value	string	是	字典翻译	"这是翻译"
comment	string	否	备注	"这是翻译"

com.leadwaycloud.system.model.dto.res.ResIssuesCommentDTO$AddDTO

添加问题评论DTO

名称	类型	必填	说明
issuesId	integer(int64)	否	问题ID
parentId	integer(int64)	否	父评论ID
content	string	否	问题内容
status	string	否	问题内容
operatorId	integer(int64)	否	操作人ID

com.leadwaycloud.system.model.dto.res.ResIssuesDTO$AddDTO

添加问题DTO

名称	类型	必填	说明
title	string	是	问题标题
content	string	是	问题内容
originId	integer(int64)	是	业务ID
originType	string	否	合同/其他
status	string	否	状态
startDate	string(date)	否	开始日期
endDate	string(date)	否	结束日期
assignPersonIdList	integer(int64)[]	否	指派人ID集合
priority	string	否	优先级
associatedTagDTO	TagDTO$AssociatedTagDTO	否
model	string	否	类型
file	integer(int64)	否	附件
departmentIdList	integer(int64)[]	否	部门ID集合

com.leadwaycloud.thirdparty.module.idaas.eiam.objects.ResponseObject

无

com.leadwaycloud.system.model.dto.ExternalDataMappingDTO$DistributeDTO

下发外部数据映射DTO

名称	类型	必填	说明
companyId	integer(int64)	是	下发映射所属公司ID
type	string	是	类型
companyIdList	integer(int64)[]	是	下发公司ID集合

com.leadwaycloud.system.model.dto.ExternalAppConfigDTO$AddDTO

外部应用配置DTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
companyId	integer(int64)	是	公司ID
businessDate	string(date)	是	营业日
shiftNo	integer(int32)	是	班次
insertCoins	string	否	投币
cashOut	string	否	现金出
customersLeaveWithoutPaying	string	否	跑单
oilGunTest	string	否	油枪测试
syncNonOilStock	boolean	是	是否同步非油库存
isAutoShelf	boolean	是	是否自动上架

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.res.ResExternalAppConfig

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResExternalAppConfig	否

com.leadwaycloud.system.model.entity.res.ResExternalAppConfig

外部数据映射配置

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户号ID
companyId	integer(int64)	是	公司ID
businessDate	string(date)	是	营业日
shiftNo	integer(int32)	是	班次
insertCoins	string	否	投币
cashOut	string	否	现金出
customersLeaveWithoutPaying	string	否	跑单
oilGunTest	string	否	油枪测试
syncNonOilStock	boolean	是	是否同步非油库存
isAutoShelf	boolean	是	是否自动上架
allowAdvanceDailyConclusion	boolean	是	允许提前日结
advanceTime	integer(int32)	是	提前时间/小时为单位
shiftSettlementNo	integer(int32)	是	班结编号

com.leadwaycloud.system.shell.model.dto.EndOfDayConfigDTO$AddDTO

添加日结配置DTO

名称	类型	必填	说明
startBusinessDate	string(date)	是	初始营业日
autoEndOfDay	boolean	是	开启自动日结
dryNegativeStockCheck	boolean	是	开启非油负库存校验
fuelInventorySummary	boolean	是	开启油品帐存差异校验
merchantId	integer(int64)	是	商户号ID
companyId	integer(int64)	是	公司ID
fuelInventorySummaryConfigDTOList	EndOfDayConfigDTO$ResFuelInventorySummaryConfigDTO[]	否	油品帐存差异配置明细

com.leadwaycloud.system.model.dto.EmailTemplateDTO$AddDTO

添加邮件模板DTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
title	string	是	标题
status	string	是	状态
type	string	是	类型
content	string	是	内容
ccRole	string	否	抄送角色ID集合
ccUser	string	否	抄送用户ID集合
addresseeUser	string	否	收件用户ID集合
notifySupplier	boolean	否	通知供应商

com.leadwaycloud.system.model.dto.EmailSendRecordDTO$SendDTO

发送DTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
companyId	integer(int64)	是	公司ID
originType	string	是	来源类型
orderCode	string	是	订单编号
addresseeUserIdList	integer(int64)[]	是	收件用户ID集合
fileBase64	string	否	fileBase64
fileName	string	否	文件名称

com.leadwaycloud.system.model.dto.CurrencyRateDTO$QueryDTO

批量查询货币汇率DTO

名称	类型	必填	说明
localDate	string	是	查询时间
fromCurrencyId	integer(int64)	是	源货币
toCurrencyId	integer(int64)	是	兑换货币

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.sys.SysCurrencyRate

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysCurrencyRate[]	否	返回数据

com.leadwaycloud.system.model.entity.sys.SysCurrencyRate

货币汇率

名称	类型	必填	说明	示例
id	integer(int64)	否
formCurrencyId	integer(int64)	是	源货币ID
toCurrencyId	integer(int64)	是	兑换货币ID
formAmount	number(double)	是	源金额	100
toAmount	number(double)	是	兑换金额
rate	number(double)	是	汇率
exchangeDate	string(date)	是	兑换时间	"2020-10-11"

com.leadwaycloud.system.model.dto.CurrencyDTO$AddDTO

添加货币数据DTO

名称	类型	必填	说明	示例
code	string	是	编号	"CNY"
name	string	是	名称	"人民币"
symbol	string	是	符号	"¥"
image	string	否	图片
rounding	integer(int32)	是	四舍五入精度
calcRate	boolean	是	是否计算汇率	true
calcRateUnit	number(double)	否	汇率计算单位

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

添加联系地址DTO

名称	类型	必填	说明	示例
countryId	integer(int64)	否	国家ID	1
stateId	integer(int64)	否	省、直辖市ID	1
cityId	integer(int64)	否	城市ID	1
areaId	integer(int64)	否	区、县ID	1
streetId	integer(int64)	否	街道ID	1
address	string	否	详细地址	"1"
postcode	string	否	邮编	"1"
phone	string	否	电话	"1"
mobile	string	否	手机	"1"
fax	string	否	传真	"1"
email	string	否	邮箱	"邮箱"

com.leadwaycloud.system.model.dto.CompanyGroupDTO$AddDTO

添加公司组DTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID	1
name	string	是	名称
code	string	是	编号
description	string	否	描述
type	string	否	类型
companyIdList	integer(int64)[]	否	公司ID集合,公司组快捷绑定公司使用

com.leadwaycloud.system.shell.model.dto.AssociateCompanyCenterWarehouseDTO

中央仓-门店关联模型

名称	类型	必填	说明	示例
companyIdList	integer(int64)[]	是	门店ID集合
centerWarehouseId	integer(int64)	是	中央仓ID

com.leadwaycloud.system.model.dto.CompanyDTO$AddDTO

添加公司DTO

名称	类型	必填	说明	示例
merchantId	integer(int64)	是	商户ID
code	string	是	公司编号（字母+数字，15位）	"CD0123456789123"
otherCode	string	否	其他编号	"AAAA-01"
type	string	是	类型	"STORE"
name	string	是	公司名称	"立威云"
image	string	否	公司LOGO
parentCompanyId	integer(int64)	是	上级公司
slogan	string	否	公司标语
currencyId	integer(int64)	否	货币ID
addContactDTO	ContactDTO$AddDTO	否
addFinanceInvoiceTitleDTO	FinanceInvoiceTitleDTO$AddDTO	否

com.leadwaycloud.system.model.dto.FinanceInvoiceTitleDTO$AddDTO

添加发票抬头信息DTO

名称	类型	必填	说明
headerName	string	否	抬头名称
address	string	否	地址
taxNo	string	否	税号
phone	string	否	电话
bank	string	否	开户银行
bankAccounts	string	否	银行账户
recipient	string	否	收件人
mailAddress	string	否	邮寄地址
receivePhone	string	否	收件人手机或电话
partnerId	integer(int64)	否	CRM关系ID
merchantId	integer(int64)	否	商户ID
billingPeriod	integer(int32)	否	账期

com.leadwaycloud.common.model.dto.ResCodeRuleDTO$GenerateCodeBatchDTO

批量生成编号请求参数DTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
codeRuleId	integer(int64)	是	编码规则ID
num	integer(int32)	是	编号个数
batchDTOList	ResCodeRuleDTO$GenerateCodeBatchDTO$BatchDTO[]	否	批量生成编号请求参数-批次参数DTO集合

com.leadwaycloud.common.model.dto.ResCodeRuleDTO$GenerateCodeBatchDTO$BatchDTO

批量生成编号请求参数-批次参数DTO

名称	类型	必填	说明
companyId	integer(int64)	否	公司ID
goodsCategoryId	integer(int64)	否	商品分类ID
dynamicChar	string	否	动态字符

com.leadwaycloud.core.model.RJava.util.ListJava.lang.String

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	string[]	否	返回数据

com.leadwaycloud.common.model.dto.ResCodeRuleDTO$UpdateDTO

编辑编号规则DTO

名称	类型	必填	说明	示例
id	integer(int64)	否	主键ID
merchantId	integer(int64)	是	商户号ID	123
type	string	是	类型	"PURCHASE_ORDER"
rule	string	是	规则json	"[{\"model\":\"RES_CODE_RULE_MODEL_CHAR\",\"index\":1,\"value\":\"JY\",\"customizeSeqCheck\":true},{\"model\":\"RES_CODE_RULE_MODEL_GOODS_CATEGORY_CODE\",\"index\":2,\"customizeSeqCheck\":true},{\"model\":\"RES_CODE_RULE_MODEL_DATE_YEAR_1\",\"index\":3,\"customizeSeqCheck\":true},{\"model\":\"RES_CODE_RULE_MODEL_CUSTOMIZE_SEQ\",\"index\":4,\"maxLength\":\"3\"}]"
active	boolean	是	是否可用	true
seq	integer(int64)	否	序列
otherType	string	否	合同细分类型
customizeSeqSql	string	否	自定义序列查询SQL

com.leadwaycloud.system.shell.model.dto.BusinessNoticeDTO$SendDTO

发送消息DTO

名称	类型	必填	说明
merchantId	boolean	是	商户号ID
companyIdList	integer(int64)[]	否	公司ID
originType	string	是	来源类型
orderCode	string	否	订单编号

com.leadwaycloud.system.model.dto.ResAttachmentDTO$AddDTO

添加附件DTO

名称	类型	必填	说明
companyId	integer(int64)	是	公司ID
merchantId	integer(int64)	是	商户ID
fileIndex	string	是	文件后缀
fileName	string	是	文件名称
originId	integer(int64)	否	源订单ID
originType	string	否	源订单类型
fileId	integer(int64)	是	文件ID
description	string	否	描述
originTypeSub	string	否	源订单子类型

com.leadwaycloud.system.model.dto.ApplicationDTO$AddDTO

添加应用DTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
sysApplicationId	integer(int64)	是	系统应用	1
name	string	是	应用名称
linkUserId	integer(int64)	否	关联用户ID
merchantId	integer(int64)	是	商户ID

com.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.sys.SysPlatformVersion

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	SysPlatformVersion[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.sys.SysPlatformVersion

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysPlatformVersion	否

com.leadwaycloud.system.model.entity.sys.SysPlatformModelVersion

平台版本模块信息

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
platformVersionId	integer(int64)	是	平台版本ID
modelId	integer(int64)	是	模块ID
content	string	是	发布内容

com.leadwaycloud.system.model.entity.sys.SysPlatformVersion

平台版本信息

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
version	string	是	版本
deployTime	string(date-time)	是	发布时间
platformModelVersionList	SysPlatformModelVersion[]	否	模块版本集合

com.leadwaycloud.core.model.PCom.leadwaycloud.monitor.model.entity.SysVersion

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	SysVersion[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.monitor.model.entity.SysVersion

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysVersion	否

com.leadwaycloud.monitor.model.entity.SysVersion

当前页数据

名称	类型	必填
id	integer(int64)	否
serviceName	string	否
code	string	否
deployTime	string(date-time)	否
content	string	否

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.monitor.model.entity.SysVersion

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysVersion[]	否	返回数据

com.leadwaycloud.core.model.RCom.leadwaycloud.monitor.model.entity.SysVersion

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysVersion	否

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.res.ResPasswordRule

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResPasswordRule	否

com.leadwaycloud.system.model.entity.res.ResPasswordRule

门店密码规则

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户号ID
maxLength	integer(int32)	是	最大长度
minLength	integer(int32)	是	最小长度
neverExpiresAllowed	boolean	是	是否允许永不过期
numericDigitRequired	boolean	是	是否必须包含数字
specialCharactersAllowed	boolean	是	允许特殊符号
specialCharactersRequired	boolean	是	是否必须包含特殊符号
upperCaseCharactersRequired	boolean	是	必需包含大写字母
lockoutDuration	integer(int32)	是	自动签出时间(分)
validateDuration	integer(int32)	是	有效期(天)
expirationNotification	boolean	是	过期提醒
defaultPasswordValidateDuration	integer(int32)	否	默认密码有效期

com.leadwaycloud.core.model.PCom.leadwaycloud.system.shell.model.vo.UserRoleVO

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	UserRoleVO[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.shell.model.vo.UserRoleVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	UserRoleVO	否

com.leadwaycloud.system.shell.model.vo.UserRoleVO

用户角色VO

名称	类型	必填	说明
companyCode	string	否	公司编号
userName	string	否	用户名称
userAccount	string	否	用户账号
userStatus	string	否	用户状态
roleName	string	否	角色名称
description	integer(int64)	否	角色描述

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	object	否	返回数据

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.vo.user.UserInfoVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	UserInfoVO	否

com.leadwaycloud.system.model.vo.user.UserInfoVO

用户基本信息VO

名称	类型	必填	说明
id	integer(int64)	否	ID
email	string	否	邮箱
mobilePhone	string	否	手机号

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.vo.PermissionsVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	PermissionsVO	否

com.leadwaycloud.system.model.entity.sys.SysFunction

功能

名称	类型	必填	说明
id	integer(int64)	否
name	string	是	名称
webMenuLevel	integer(int32)	是	页面菜单级别
webType	string	是	页面类型
webRouter	string	是	页面路由
apiId	integer(int64)	否	API接口路径
index	integer(int32)	是	页面渲染顺序
description	string	否	描述
buttonType	string	否	按钮类型
parentId	integer(int64)	否	上级功能Id
modelId	integer(int64)	是	模块
menuId	integer(int64)	是	菜单
appId	integer(int64)	否	sys_app.id
app	SysApp	否

com.leadwaycloud.system.model.entity.sys.SysMenu

菜单

名称	类型	必填	说明	示例
id	integer(int64)	否
code	string	是	唯一标识
name	string	是	名称
active	boolean	是	是否可用	true
description	string	否	描述
filter	string	是	根据参数过滤菜单
button	string	是	菜单下的按钮json
image	string	否	图标

com.leadwaycloud.system.model.entity.sys.SysModel

模块

名称	类型	必填	说明	示例
id	integer(int64)	否
code	string	是	唯一标识
name	string	是	名称
active	boolean	是	是否可用	true
description	string	否	描述
version	string	是	版本编号
image	string	是	图片
appId	integer(int64)	否	sys_app.id
app	SysApp	否

com.leadwaycloud.system.model.vo.PermissionsVO

查询权限信息模型

名称	类型	必填	说明
functionList	SysFunction	否
modelMap	object	否	模块集合
menuMap	object	否	菜单集合
roleList	ResRole	否

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.res.ResUser

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResUser[]	否	返回数据

com.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResUser

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	ResUser[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResUser

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResUser	否

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.vo.user.ResUserDetailVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResUserDetailVO	否

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

部门

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
name	string	是	名称
parentId	integer(int64)	否	上一级ID
idChain	string	是	完整的组织架构值
phone	string	否	电话
fax	string	否	传真
email	string	否	邮箱
note	string	否	备注
companyId	integer(int64)	是	公司ID
merchantId	integer(int64)	是	商户号ID
externalCode	string	否	外部编号
code	string	是	编号
status	string	是	状态
idaasId	string	否	idaas唯一ID
shortName	string	否	简称

com.leadwaycloud.system.model.vo.user.ResUserDetailVO

返回用户详情

名称	类型	必填	说明
id	integer(int64)	否	ID
status	string	否	状态
userName	string	否	登录名称
language	string	否	语言
companyId	integer(int64)	否	公司ID
merchantId	integer(int64)	否	商户ID
readVersionInfo	boolean	否	是否已读更新版本信息
name	string	否	名称
image	string	否	图片
partnerId	integer(int64)	否	CRM关系ID
registerChannel	string	否	注册渠道
contact	ResContact	否
roleEntityList	ResRole	否
companyEntityList	ResCompany	否
password	string	否	密码
hrEmployeeList	HrDepartment	否
sign	string	否	签名
createTime	string(date-time)	否	创建时间
createBy	integer(int64)	否	创建人ID
updateTime	string(date-time)	否	修改时间
updateBy	integer(int64)	否	修改人ID

com.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.sys.SysUom

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	SysUom[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.sys.SysUom

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysUom	否

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.res.ResTripLine

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResTripLine[]	否	返回数据

com.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResTripLine

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	ResTripLine[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResTripLine

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResTripLine	否

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.res.ResTagGroup

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResTagGroup[]	否	返回数据

com.leadwaycloud.system.model.entity.res.ResTagGroup

标签组

名称	类型	必填	说明
id	integer(int64)	否
name	string	是	组名称
merchantId	integer(int64)	是	商户ID
description	string	否	描述

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.res.ResTag

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResTag[]	否	返回数据

com.leadwaycloud.system.model.entity.res.ResTag

标签

名称	类型	必填	说明
id	integer(int64)	否
name	string	是	标签名称
status	string	是	状态
merchantId	integer(int64)	是	商户ID
groupId	integer(int64)	否	组ID
type	string	否	标签类型如GOODS,COMPANY,SUPPLIER
description	string	否	描述
tagGroup	ResTagGroup	否

com.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResTag

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	ResTag[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResTag

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResTag	否

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.res.ResTag

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResTag	否

com.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.sys.SysProperty

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	SysProperty[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.sys.SysProperty

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysProperty	否

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.sys.SysProperty

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysProperty	否

com.leadwaycloud.core.model.RCom.leadwaycloud.system.shell.model.entitys.ResShiftReconciliationConfig

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResShiftReconciliationConfig	否

com.leadwaycloud.system.shell.model.entitys.ResShiftReconciliationConfig

返回数据

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户号ID
companyId	integer(int64)	是	公司ID
config	integer(int64)	是	配置

com.leadwaycloud.core.model.PCom.leadwaycloud.system.shell.model.vo.RoleFunctionVO

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	RoleFunctionVO[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.shell.model.vo.RoleFunctionVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RoleFunctionVO	否

com.leadwaycloud.system.shell.model.vo.RoleFunctionVO

角色功能VO

名称	类型	必填	说明
functionName	string	否	功能名称
modelName	string	否	模块名称
menuName	string	否	菜单名称
roleName	string	否	角色名称
companyCode	string	否	门店编号
description	string	否	角色描述

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.vo.role.RoleListVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RoleListVO[]	否	返回数据

com.leadwaycloud.system.model.vo.role.RoleListVO

角色列表VO

名称	类型	必填	说明
id	integer(int64)	否	角色ID
name	string	否	角色名称
description	string	否	描述
companyId	integer(int64)	否	公司ID
companyName	string	否	公司名称

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.res.ResRole

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRole[]	否	返回数据

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

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	integer(int64)[]	否	返回数据

com.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResRole

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	ResRole[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResRole

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRole	否

com.leadwaycloud.system.model.dto.RoleDTO$QueryDTO

查询角色DTO

名称	类型	必填	说明	示例
companyId	integer(int64)	是	公司ID	1
name	string	否	角色名称	"运维组"
system	boolean	否	是否是系统创建角色	true
companyType	string	否	公司类型	"STORE"
template	boolean	否	是否是模板	true
appId	integer(int64)	否	sys_app.id

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.vo.RoleDetailsVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	RoleDetailsVO	否

com.leadwaycloud.system.model.vo.RoleDetailsVO

角色详情模型

名称	类型	必填	说明
role	ResRole	否
functionList	SysFunction	否
modelMap	object	否	模块集合

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.sys.SysReportGroup

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysReportGroup[]	否	返回数据

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.vo.ReportRefVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ReportRefVO	否

com.leadwaycloud.system.model.vo.ReportRefVO

报表绑定

名称	类型	必填	说明	示例
userList	ResUser	否
roleList	ResRole	否

com.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.sys.SysReport

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	SysReport[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.sys.SysReport

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysReport	否

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.res.ResReasonCodeType

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResReasonCodeType[]	否	返回数据

com.leadwaycloud.system.model.entity.res.ResReasonCodeType

原因码分组

名称	类型	必填	说明	示例
id	integer(int64)	否
merchantId	integer(int64)	是	商户ID
name	string	是	角色名称	"运维组"
orderType	string	是	单据类型

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.res.ResReasonCode

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResReasonCode[]	否	返回数据

com.leadwaycloud.system.model.entity.res.ResReasonCode

原因码

名称	类型	必填	说明
id	integer(int64)	否
code	string	是	原因码
merchantId	integer(int64)	是	商户ID
name	string	是	名称
typeId	integer(int64)	是	类型ID
externalCode	string	否	外部编号
push	boolean	是	是否推送ERP-壳牌
reasonCodeType	ResReasonCodeType	否

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.res.ResReasonCode

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResReasonCode	否

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.res.ResRatingTopic

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRatingTopic[]	否	返回数据

com.leadwaycloud.system.model.entity.res.ResRatingCategory

评价分类

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
name	string	否	名称
code	string	否	编号
parentId	integer(int64)	否	上一级id
merchantId	integer(int64)	否	商户id
idChain	string	否	完整的组织结构
status	string	否	状态
ratingUserId	integer(int64)	否	评价人ID

com.leadwaycloud.system.model.entity.res.ResRatingTopic

评价题库

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
ratingCategoryId	integer(int64)	否	评价分类id
content	string	否	内容（评价规则）
totalScore	integer(int64)	否	得分
merchantId	integer(int64)	否	评价分类id
status	string	否	状态
resRatingCategory	ResRatingCategory	否
resRatingCategoryList	ResRatingCategory[]	否	评价分类对象集合

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.res.ResRatingTopic

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRatingTopic	否

com.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResRatingTemplate

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	ResRatingTemplate[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResRatingTemplate

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRatingTemplate	否

com.leadwaycloud.system.model.entity.res.ResRatingTemplate

评价模版

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
type	string	否	类型(合同/其他)
totalPenalty	number(double)	否	总扣分
note	string	否	备注
status	string	否	状态
name	string	否	名称
merchantId	integer(int64)	是	商户ID
companyId	integer(int64)	是	公司Id
resRatingTopicList	ResRatingTopic[]	否	题库集合

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.res.ResRatingTemplate

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRatingTemplate[]	否	返回数据

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.res.ResRatingTemplate

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRatingTemplate	否

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.res.ResRating

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRating[]	否	返回数据

com.leadwaycloud.system.model.entity.res.ResRating

评价

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
ratingTplId	integer(int64)	否	模版id
originType	string	否	源订单类型
originId	integer(int64)	否	源订单id
totalPenalty	number(double)	否	总扣分
status	string	否	状态
stockContract	StockContract	否
operator	ResUser	否
resRatingTemplate	ResRatingTemplate	否
resIssuesRatingLineList	ResRatingLine[]	否	评价明细集合

com.leadwaycloud.system.model.entity.res.ResRatingLine

评价明细

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
ratingId	integer(int64)	否	问题评价表id
ratingTopicId	integer(int64)	否	问题评价题库表id
ratingUserId	integer(int64)	否	评价人
penalty	number(double)	否	扣分
note	string	否	备注
status	string	否	状态
issuesDescription	string	否	问题描述
issuesQty	integer(int32)	否	问题数量
ratingUser	ResUser	否
resRatingTopic	ResRatingTopic	否
hrDepartmentList	HrDepartment[]	否	部门

com.leadwaycloud.system.model.entity.stock.StockContract

合同

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
pickingType	string	是	订单类型
status	string	是	合同状态
name	string	否	合同名称
doneTime	string(date-time)	否	完成时间
code	string	是	合同编号
externalCode	string	否	外部编号
currencyId	integer(int64)	是	货币符号ID
exchangeRate	number(double)	是	汇率
operatorUserId	integer(int64)	是	操作用户ID
partnerId	integer(int64)	是	客户关系对象
taxType	string	是	税金计算类型
amountTotal	number(double)	否	含税总额
amountTax	number(double)	否	税总额
amountUntaxed	number(double)	否	不含税总额
merchantId	integer(int64)	是	商户ID
companyId	integer(int64)	是	公司ID
note	string	否	备注
startDate	string(date)	是	开始时间
endDate	string(date)	是	结束时间
originId	integer(int64)	否	源订单ID
originType	string	否	源订单类型
departmentId	integer(int64)	否	部门ID
advance	boolean	否	是否预付
advanceRatio	number(double)	否	预付比例
reviewMethod	string	否	评审方式
signDate	string(date)	否	签订日期
signLocation	string	否	签署地点
contractType	string	否	合同类型（正式合同,预投合同,科研合同）
saleDestination	string	否	销售去向
producePlanMode	string	否	生产组织方式（内厂/外厂生产）
version	string	否	版本号
machineType	string	否	机型
checkEffectiveAmount	boolean	否	是否检查有效金额
contractEffectiveType	string	否	合同有效类型
history	boolean	否	是否是历史合同
goodsType	string	否	合同商品类型
decalsContract	boolean	否	是否开口合同，用于采购单金额验证(标准类型商品)-万航
excessRatio	number(double)	否	超出额度比例，用于采购单金额验证(原材料类型商品)-万航
goodsSubType	string	否	合同商品子类型
origin	string	否	来源
initialization	boolean	否	是否初始化数据
executedAmountTotal	number(double)	否	期初已执行金额（含税）
executedAmountUntaxed	number(double)	否	期初已执行金额（不含税）
executedAmountTax	number(double)	否	期初已执行税总额
warrantyRatio	number(double)	否	合同总价款中用作质量保证的预留金比例
warrantyPeriod	string	否	项目质量保修期限(支持单位：年、月、天，默认为月)
extensionInfo	string	否	额外属性

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.res.ResRating

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRating	否

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.res.ResRatingCategory

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRatingCategory[]	否	返回数据

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.res.ResRatingCategory

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResRatingCategory	否

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.sys.SysPrinterTemplateConfig

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysPrinterTemplateConfig[]	否	返回数据

com.leadwaycloud.system.model.entity.sys.SysPrinterTemplateConfig

系统打印机模板配置

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
name	string	是	名称
description	string	否	描述
status	string	是	状态
type	string	是	模版类型
reportId	integer(int64)	否	报表ID
receiptCode	string	否	单据代号
apiId	integer(int64)	否	打印模板对应的数据源API ID
configData	string	是	打印模版配置
merchantId	integer(int64)	否	商户ID
api	SysApi	否

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.sys.SysPrinterTemplateConfig

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysPrinterTemplateConfig	否

com.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.sys.SysOperationalDoc

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	SysOperationalDoc[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.sys.SysOperationalDoc

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysOperationalDoc	否

com.leadwaycloud.system.model.entity.sys.SysOperationalDoc

当前页数据

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
industry	string	是	行业	"COMPLEX"
modelId	integer(int64)	是	系统模块ID
menuId	integer(int64)	否	系统菜单ID
customMenu	string	否	自定义菜单	"xxxxx"
model	SysModel	否
menu	SysMenu	否
detailList	SysOperationalDocDetail[]	否	操作文档文件

com.leadwaycloud.system.model.entity.sys.SysOperationalDocDetail

操作文档文件

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
operationalDocId	integer(int64)	是	系统操作文档ID
langId	integer(int64)	是	文档语言ID
fileName	string	是	文件名称
fileType	string	是	文件类型
fileId	string	是	文件服务器上的文件ID
lang	ResLang	否

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.sys.SysOperationalDoc

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysOperationalDoc	否

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.sys.SysModel

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysModel[]	否	返回数据

com.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResOpenApiLog

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	ResOpenApiLog[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResOpenApiLog

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResOpenApiLog	否

com.leadwaycloud.system.model.entity.res.ResOpenApiLog

开放API日志表

名称	类型	必填	说明
id	integer(int64)	否
merchantId	integer(int64)	是	商户号ID
businessType	string	否	业务类型
businessId	string	否	业务ID（多个用逗号隔开，例如：1,2,3）
interactSys	string	是	系统
interactFunction	string	是	功能
requestId	string	是	请求唯一ID
requestTime	string(date-time)	是	请求时间
requestContent	string	是	请求参数
responseTime	string(date-time)	否	响应时间
responseContent	string	否	响应内容
createTime	string(date-time)	是	创建时间
syncDirection	integer(int32)	否	同步方向（1:PUSH - 推送出去，2:PULL - 接收推送）
batch	string	否	批次
openApiProcessedList	ResOpenApiProcessed[]	否	系统请求日志处理结果集合

com.leadwaycloud.system.model.entity.res.ResOpenApiProcessed

系统请求日志处理结果表

名称	类型	必填	说明
id	integer(int64)	否
merchantId	integer(int64)	是	商户号ID
requestId	string	是	请求唯一ID
success	boolean	是	是否处理成功
processed	string	否	处理结果
createTime	string(date-time)	否	创建时间

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.res.ResOpenApiLog

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResOpenApiLog	否

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.res.ResMerchant

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResMerchant	否

com.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResUserManageLog

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	ResUserManageLog[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResUserManageLog

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResUserManageLog	否

com.leadwaycloud.system.model.entity.res.ResUserManageLog

当前页数据

名称	类型	必填	说明
id	integer(int64)	否
merchantId	integer(int64)	是	商户ID
companyId	integer(int64)	是	公司ID
updateUserId	integer(int64)	是	编辑用户ID
updateUserName	string	是	编辑用户账号
functionId	integer(int64)	是	菜单ID
functionName	string	是	菜单名称
responseContent	string	是	请求结果
createTime	string(date-time)	否	创建时间
createBy	integer(int64)	否	创建人ID
createByName	string	否	创建人名称

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.sys.SysFunction

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysFunction[]	否	返回数据

com.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResUserLoginLog

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	ResUserLoginLog[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResUserLoginLog

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResUserLoginLog	否

com.leadwaycloud.system.model.entity.res.ResUserLoginLog

当前页数据

名称	类型	必填	说明
id	integer(int64)	否
date	string(date-time)	否	修改时间
device	string	是	设备信息
host	string	是	IP信息
userId	integer(int64)	是	用户ID
userName	string	否	用户名称
responseContent	string	否	请求结果
merchantId	integer(int64)	否	商户ID

com.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.sys.SysGatewaySessionRecord

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	SysGatewaySessionRecord[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.sys.SysGatewaySessionRecord

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysGatewaySessionRecord	否

com.leadwaycloud.system.model.entity.sys.SysGatewaySessionRecord

日志

名称	类型	必填	说明
id	integer(int64)	否
merchantId	integer(int64)	否	商户ID
userId	integer(int64)	否	用户ID
businessCompanyId	integer(int64)	否	作业公司ID
functionId	integer(int64)	否	功能ID
requestTime	string(date-time)	否	请求时间
result	boolean	否	接口处理结果 true:成功 false:失败
message	string	否	消息
functionName	string	否	功能名称
menuName	string	否	菜单名称
userName	string	否	用户名称
modelName	string	否	模块名称
businessCompanyCode	string	否	作业公司
roleName	string	否	角色名称

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.res.ResTranslation

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResTranslation[]	否	返回数据

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.res.ResLang

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResLang[]	否	返回数据

com.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResIssues

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	ResIssues[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResIssues

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResIssues	否

com.leadwaycloud.system.model.entity.res.ResIssues

问题

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
title	string	是	问题标题
content	string	是	问题内容
originId	integer(int64)	是	业务ID
originType	string	否	合同/其他
status	string	否	状态
startDate	string(date)	否	开始日期
endDate	string(date)	否	结束日期
priority	string	否	优先级
model	string	否	类型
file	integer(int64)	否	附件
userList	ResUser[]	否	指派人对象集合
departmentList	HrDepartment[]	否	部门集合
tagList	ResTag[]	否	标签集合

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.res.ResIssues

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResIssues	否

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.res.ResIssuesComment

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResIssuesComment[]	否	返回数据

com.leadwaycloud.system.model.entity.res.ResIssuesComment

问题评论

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
issuesId	integer(int64)	否	问题ID
parentId	integer(int64)	否	父评论ID
content	string	否	问题内容
status	string	否	问题内容
operatorId	integer(int64)	否	操作人ID
operatorUser	ResUser	否

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.sys.SysImportTemplate

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysImportTemplate	否

com.leadwaycloud.system.model.entity.sys.SysImportTemplate

导入模板

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
fileId	string	是	文件ID
type	string	是	导入模板类型
version	string	是	版本

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.res.ResExternalDataMapping

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResExternalDataMapping[]	否	返回数据

com.leadwaycloud.system.model.entity.res.ResExternalDataMapping

外部数据映射

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户号ID
companyId	integer(int64)	是	公司ID
erpCode	string	否	ERP编号
externalCode	string	是	外部编号
description	string	否	描述
other	string	否	其他字段
type	string	是	类型

com.leadwaycloud.core.model.RCom.leadwaycloud.system.shell.model.entitys.ResEndOfDayConfig

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResEndOfDayConfig	否

com.leadwaycloud.system.shell.model.entitys.ResEndOfDayConfig

日结配置

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
startBusinessDate	string(date)	是	初始营业日
autoEndOfDay	boolean	是	开启自动日结
dryNegativeStockCheck	boolean	是	开启非油负库存校验
fuelInventorySummary	boolean	是	开启油品帐存差异校验
merchantId	integer(int64)	是	商户号ID
companyId	integer(int64)	是	公司ID
fuelInventorySummaryConfigList	ResFuelInventorySummaryConfig[]	是	油品帐存差异配置明细

com.leadwaycloud.system.shell.model.entitys.ResFuelInventorySummaryConfig

油品帐存差异配置

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
companyId	integer(int64)	是	公司ID
goodsId	integer(int64)	是	商品ID
minQty	number(double)	是	差异最小值
maxQty	number(double)	是	差异最大值

com.leadwaycloud.system.model.dto.EmailTemplateDTO$QueryDTO

查询邮件模板DTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
title	string	否	标题
status	string	否	状态
type	string	否	类型

com.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResEmailTemplate

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	ResEmailTemplate[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResEmailTemplate

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResEmailTemplate	否

com.leadwaycloud.system.model.entity.res.ResEmailTemplate

邮件模板

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户号ID
title	integer(int64)	否	标题
status	string	是	状态
type	string	是	类型
content	string	否	内容
ccRole	string	否	抄送角色ID集合
ccUser	string	否	抄送用户ID集合
addresseeUser	string	否	收件用户ID集合
notifySupplier	boolean	否	是否通知供应商
ccRoleList	ResRole[]	否	抄送角色集合
ccUserList	ResUser[]	否	抄送用户集合
addresseeUserList	ResUser[]	否	收件用户集合

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.res.ResEmailTemplate

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResEmailTemplate	否

com.leadwaycloud.system.model.dto.EmailSendRecordDTO$QueryDTO

查询邮件发送记录DTO

名称	类型	必填	说明
merchantId	integer(int64)	是	商户号ID
companyIdList	integer(int64)[]	否	公司ID集合
originType	string	否	来源类型
addresseeEmail	string	否	收件人邮箱
orderCode	string	否	订单编号
title	string	否	标题
result	boolean	否	处理结果
startTime	string(date-time)	否	开始时间
endTime	string(date-time)	否	结束时间

com.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResEmailSendRecord

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	ResEmailSendRecord[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResEmailSendRecord

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResEmailSendRecord	否

com.leadwaycloud.system.model.entity.res.ResEmailSendRecord

邮件发送记录

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户号ID
companyId	integer(int64)	是	公司ID
companyCode	string	是	公司编号
originType	string	是	来源类型
addresseeCode	string	是	收件人编号
addresseeEmail	string	是	收件人邮箱
orderCode	string	是	订单编号
title	string	是	标题
content	string	是	内容
result	boolean	是	处理结果
sendTime	string(date-time)	否	发送时间
fileBase64	integer(int64)	否	发送时间
fileName	integer(int64)	否	商户号ID

com.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResDynamicTask

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	ResDynamicTask[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResDynamicTask

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResDynamicTask	否

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.sys.SysDeviceCommand

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysDeviceCommand[]	否	返回数据

com.leadwaycloud.system.model.entity.sys.SysDeviceCommand

设备指令模型

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
brand	string	是	品牌
model	string	是	型号
type	string	是	设备类型(PRINTER:打印机)	"PRINTER"
command	string	是	指令集

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.entity.sys.SysCurrencyRate

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysCurrencyRate	否

com.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.sys.SysCurrencyRate

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	SysCurrencyRate[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.sys.SysCurrencyRate

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysCurrencyRate	否

com.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.sys.SysCurrency

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	SysCurrency[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.sys.SysCurrency

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysCurrency	否

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.sys.SysCurrency

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysCurrency[]	否	返回数据

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.vo.AddressVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	AddressVO[]	否	返回数据

com.leadwaycloud.system.model.vo.AddressVO

五级联动数据数据模版

名称	类型	必填	说明
id	integer(int64)	否	ID
code	string	否	代号
name	string	否	名称

com.leadwaycloud.core.model.PCom.leadwaycloud.system.model.vo.company.CompanyGroupListVO

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	CompanyGroupListVO[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.model.vo.company.CompanyGroupListVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	CompanyGroupListVO	否

com.leadwaycloud.system.model.vo.company.CompanyGroupListVO

公司组列表VO

名称	类型	必填	说明
id	integer(int64)	否	ID
merchantId	integer(int64)	否	商户ID
name	string	否	名称
code	string	否	编号
description	string	否	描述
status	string	否	状态
type	string	否	类型
companyList	CompanyGroupListVO$CompanyVO[]	否	绑定公司VO集合

com.leadwaycloud.system.model.vo.company.CompanyGroupListVO$CompanyVO

绑定公司VO

名称	类型	必填	说明
id	integer(int64)	否	公司ID
code	string	否	公司编号（仅允许字母和数字）
name	string	否	名称
type	string	否	类型

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.vo.company.CompanyGroupDetailVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	CompanyGroupDetailVO	否

com.leadwaycloud.system.model.vo.company.CompanyGroupDetailVO

公司组详情VO

名称	类型	必填	说明
id	integer(int64)	否	ID
merchantId	integer(int64)	否	商户ID
name	string	否	名称
code	string	否	编号
description	string	否	描述
status	string	否	状态
type	string	否	类型
createTime	string(date-time)	否	创建时间
updateTime	string(date-time)	否	编辑时间
companyList	CompanyGroupDetailVO$CompanyVO[]	否	绑定公司VO集合

com.leadwaycloud.system.model.vo.company.CompanyGroupDetailVO$CompanyVO

绑定公司VO

名称	类型	必填	说明
id	integer(int64)	否	公司ID
code	string	否	公司编号（仅允许字母和数字）
name	string	否	名称
type	string	否	类型

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.shell.model.vo.CenterStoreVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	CenterStoreVO[]	否	返回数据

com.leadwaycloud.system.shell.model.vo.CenterStoreVO

中央仓/油站VO

名称	类型	必填	说明
id	integer(int64)	否	公司ID
code	integer(int64)	否	公司编号
parentId	integer(int64)	否	上级公司ID
type	string	否	类型
status	string	否	状态
name	string	否	名称
idChain	string	否	公司ID完整架构
merchantId	integer(int64)	否	商户ID
merchantCode	string	否	商户编号
partnerId	integer(int64)	否	CRM关系ID
currency	CenterStoreVO$CurrencyVO	否

com.leadwaycloud.system.shell.model.vo.CenterStoreVO$CurrencyVO

货币VO

名称	类型	必填	说明
code	string	否	编号
name	string	否	名称
symbol	string	否	符号
active	boolean	否	是否可用
calcRate	boolean	否	是否计算汇率
image	string	否	图片
rounding	integer(int32)	否	四舍五入精度
calcRateUnit	number(double)	否	汇率计算单位

com.leadwaycloud.core.model.RCom.leadwaycloud.system.shell.model.vo.CenterStoreVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	CenterStoreVO	否

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.shell.model.vo.CenterWarehouseVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	CenterWarehouseVO[]	否	返回数据

com.leadwaycloud.system.shell.model.vo.CenterWarehouseVO

油站信息VO

名称	类型	必填	说明
id	integer(int64)	否	油站ID
code	integer(int64)	否	油站编号
name	integer(int64)	否	油站名称
centerVOList	CenterWarehouseVO$CenterVO[]	否	中央仓信息VO

com.leadwaycloud.system.shell.model.vo.CenterWarehouseVO$CenterVO

中央仓信息VO

名称	类型	必填	说明
id	integer(int64)	否	中央仓ID
code	string	否	中央仓编号
name	string	否	中央仓名称

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.vo.ManageableCompanyVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ManageableCompanyVO[]	否	返回数据

com.leadwaycloud.system.model.vo.ManageableCompanyVO

可管理公司VO

名称	类型	必填	说明
id	integer(int64)	否	公司ID
code	string	否	公司编号（仅允许字母和数字）
name	string	否	名称
parentId	integer(int64)	否	上级公司ID
type	string	否	类型
status	string	否	状态
idChain	string	否	公司ID完整架构（上下级公司id用-连接）
partnerId	integer(int64)	否	CRM关系ID
image	string	否	图片

com.leadwaycloud.core.model.RCom.leadwaycloud.system.model.vo.company.PublicCompanyVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	PublicCompanyVO	否

com.leadwaycloud.system.model.vo.company.PublicCompanyVO

公司信息VO

名称	类型	必填	说明
id	integer(int64)	否	公司ID
merchantId	integer(int64)	否	商户ID
code	string	否	公司编号
name	string	否	公司名称
image	string	否	公司图片

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.vo.CompanyListVO

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	CompanyListVO[]	否	返回数据

com.leadwaycloud.system.model.vo.CompanyListVO

公司列表VO

名称	类型	必填	说明
id	integer(int64)	否	公司ID
code	string	否	公司编号（仅允许字母和数字）
name	string	否	名称
parentId	integer(int64)	否	上级公司ID
type	string	否	类型
status	string	否	状态
idChain	string	否	公司ID完整架构（上下级公司id用-连接）
merchantId	integer(int64)	否	商户ID
merchantCode	string	否	商户编号
partnerId	integer(int64)	否	CRM关系ID
otherCode	string	否	其他编号
currency	CurrencyVO	否

com.leadwaycloud.system.model.vo.CurrencyVO

币种VO

名称	类型	必填	说明
id	integer(int64)	否	ID
code	string	否	编号
name	string	否	名称
symbol	string	否	符号

com.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResCodeRule

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	ResCodeRule[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.res.ResCodeRule

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResCodeRule	否

com.leadwaycloud.system.model.entity.res.ResCodeRule

当前页数据

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户号ID
type	string	是	类型
rule	string	是	规则json
active	boolean	是	是否可用
seq	integer(int64)	否	序列
otherType	string	否	其他类型
customizeSeqSql	string	否	自定义序列查询SQL

com.leadwaycloud.core.model.RJava.lang.String

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	string	否	返回数据

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.sys.SysCalendar

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysCalendar[]	否	返回数据

com.leadwaycloud.system.model.entity.sys.SysCalendar

返回数据

名称	类型	必填	说明
id	integer(int64)	是	ID
year	integer(int32)	是	年
month	integer(int32)	是	月
day	integer(int32)	是	日
lunar	string	否	农历
holiday	string	否	法定节假日
solarTerms	string	否	节气
weekInYear	integer(int32)	否	一年中的第几周
dayInYear	integer(int32)	否	一年中的第几天
leapYear	boolean	否	是否闰年
festival	string	否	节日
otherFestival	string	否	其他节日

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.res.ResCalendar

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResCalendar[]	否	返回数据

com.leadwaycloud.system.model.entity.res.ResCalendar

返回数据

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantId	integer(int64)	是	商户ID
companyId	integer(int64)	否	公司ID
sysCalendarId	integer(int64)	是	系统日历ID
year	integer(int32)	是	年
month	integer(int32)	是	月
day	integer(int32)	是	日
holiday	string	否	商户规定节假日，如果未设定则按照国家法定节假日执行

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.res.ResAttachment

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResAttachment[]	否	返回数据

com.leadwaycloud.system.model.entity.res.ResAttachment

附件表

名称	类型	必填	说明
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
companyId	integer(int64)	是	公司ID
merchantId	integer(int64)	是	商户ID
fileIndex	string	是	文件后缀
fileName	string	是	文件名称
originId	integer(int64)	是	源订单ID
originType	string	是	源订单类型
fileId	integer(int64)	是	文件ID
description	string	否	描述
originTypeSub	string	否	源订单子类型
createUser	ResUser	否

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.sys.SysApplication

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysApplication[]	否	返回数据

com.leadwaycloud.system.model.entity.sys.SysApplication

应用程序模型

名称	类型	必填	说明	示例
id	integer(int64)	否
createBy	integer(int64)	否
createTime	string(date-time)	否
updateBy	integer(int64)	否
updateTime	string(date-time)	否
merchantIndustry	string	是	商户行业
companyType	string	是	公司类型
name	string	是	名称	"name"
image	string	否	图片
description	string	否	描述
active	boolean	是	是否可用

com.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.sys.SysApi

返回数据

名称	类型	必填	说明	示例
first	boolean	是	是否是第一页	true
last	boolean	是	是否是最后一页	true
totalPages	integer(int32)	是	总页数	1
totalElements	integer(int64)	是	总数据条数	1
size	integer(int32)	是	每页条数	10
number	integer(int32)	是	当前页码	0
numberOfElements	integer(int32)	是	当前页数据条数	0
dataList	SysApi[]	否	当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.system.model.entity.sys.SysApi

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	SysApi	否

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.system.model.entity.res.ResApplication

名称	类型	必填	说明	示例
status	integer(int32)	是	状态码	200
code	string	是	业务代码	"000"
message	string	是	消息描述	"成功"
data	ResApplication[]	否	返回数据