服务地址
| 地址 | 说明 |
|---|
| http://localhost:8080 | 开发环境 |
| https://api.leadwaycloud.com | 测试环境 |
接口详情
PUT
/sys/api/user/update-password/{id}
用户管理
修改密码接口
OperationId: updatePassword
调用方法
PUT /sys/api/user/update-password/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 用户ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: ChangePasswordDTO com.leadwaycloud.manager.business.manager.dto.ChangePasswordDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| newPassword | string | 是 | MD5(1qazxsw) | |
| confirmPassword | string | 是 | 确认密码 | "MD5(1qazxsw)" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
PUT
/sys/api/user/update-info/{id}
用户管理
修改用户信息接口
OperationId: updateInfo
调用方法
PUT /sys/api/user/update-info/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 用户ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateUserDTO com.leadwaycloud.manager.business.manager.dto.UpdateUserDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| name | string | 否 | 名称 | "管理员" |
| status | string | 否 | 状态 【 INACTIVATED : 待激活的 ACTIVE : 活跃的 BLOCK : 锁定的 DELETE : 被删除的 】 | "ACTIVE" |
| image | string | 否 | 头像 | |
| phone | string | 否 | 电话 | "0288888888" |
| mobilePhone | string | 否 | 手机 | "13888888888" |
| address | string | 否 | 地址 | "四川省成都市" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: ManagerUser com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.manager.entity.ManagerUser
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ManagerUser | 否 | | |
PUT
/sys/api/user/forgot-password
用户管理
忘记密码接口
OperationId: forgotPassword
调用方法
PUT /sys/api/user/forgot-password
参数
无
请求体
Content-Type: application/json 必填: 是 类型: ForgetPasswordDTO com.leadwaycloud.manager.business.manager.dto.ForgetPasswordDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| account | string | 是 | 账号 | |
| captcha | string | 是 | 验证码 | |
| newPassword | string | 是 | MD5(1qazxsw) | |
| confirmPassword | string | 是 | 确认密码 | "MD5(1qazxsw)" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
PUT
/sys/api/user/activation
用户管理
账号激活接口
OperationId: updatePassword_1
调用方法
PUT /sys/api/user/activation
参数
无
请求体
Content-Type: application/json 必填: 是 类型: ActivationUserDTO com.leadwaycloud.manager.business.manager.dto.ActivationUserDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| account | string | 是 | 账号 | |
| captcha | string | 是 | 验证码 | |
| newPassword | string | 是 | MD5(1qazxsw) | |
| confirmPassword | string | 是 | 确认密码 | "MD5(1qazxsw)" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
PUT
/erp/api/version-manager/update/{id}
版本号管理(作废)
编辑版本接口
OperationId: update
已废弃
调用方法
PUT /erp/api/version-manager/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
Content-Type: application/json 必填: 是 类型: SysVersionDTO$UpdateDTO com.leadwaycloud.monitor.model.dto.SysVersionDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| serviceName | string | 否 | | |
| code | string | 否 | | |
| deployTime | string(date-time) | 否 | | |
| content | string | 否 | | |
响应
状态码: 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 | 否 | | |
PUT
/erp/api/user/update-readVersionInfo
商户用户管理接口
-
OperationId: updateUserReadVersionInfo
调用方法
PUT /erp/api/user/update-readVersionInfo
参数
无
请求体
Content-Type: application/json 必填: 是 类型: boolean
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
PUT
/erp/api/uom/update/{id}
计量单位管理接口
修改计量单位接口
OperationId: update_1
调用方法
PUT /erp/api/uom/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateUomDTO com.leadwaycloud.manager.business.uom.dto.UpdateUomDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 否 | 编号 | "1" |
| name | string | 否 | 名称 | "公斤" |
| symbol | string | 否 | 符号 | "kg" |
| subUomId | integer(int64) | 否 | 下级计量单位ID | 2 |
| ratio | number(double) | 否 | 换算率 | 1000 |
| active | boolean | 否 | 是否可用 | true |
| shortName | string | 否 | 简称 | |
| isoShortName | string | 否 | ISO简称 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysUom com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.uom.entity.SysUom
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysUom | 否 | | |
PUT
/erp/api/sys-printer-template/update/{id}
系统打印模版管理接口
修改系统打印模版接口
OperationId: update_2
调用方法
PUT /erp/api/sys-printer-template/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
Content-Type: application/json 必填: 是 类型: UpdateSysReportPrinterTemplateConfigDTO com.leadwaycloud.manager.business.printer.template.dto.UpdateSysReportPrinterTemplateConfigDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| name | string | 否 | 名称 | |
| description | string | 否 | 描述 | |
| status | string | 否 | 状态 【 DRAFT : 草稿 VALID : 可用 VOID : 作废 】 | "DRAFT" |
| configData | string | 否 | 打印模版配置 | |
| merchantId | integer(int64) | 否 | 商户ID(专门为该商户设计时需提供) | 1 |
| company | integer(int64)[] | 否 | 公司(设置了公司，必须提供商户ID) | |
| targetType | string | 否 | 模版目标对象类型 【 SUPPLIER : 供应商 CUSTOMER : 客户 AGENT : 代理商 CARRIER : 承运商 PRODUCER : 生产商 MEMBER : 会员 】 | |
| targets | integer(int64)[] | 否 | 模版目标对象 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysPrinterTemplateConfig com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.printer.template.entity.SysPrinterTemplateConfig
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysPrinterTemplateConfig | 否 | | |
PUT
/erp/api/setting/delete/{id}
系统参数管理接口
删除系统参数接口
OperationId: delete
物理删除
调用方法
PUT /erp/api/setting/delete/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
PUT
/erp/api/report/update/{id}
系统报表管理接口
修改系统报表接口
OperationId: update_3
调用方法
PUT /erp/api/report/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 报表ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateReportDTO com.leadwaycloud.manager.business.report.dto.UpdateReportDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| modelId | integer(int64) | 否 | 所属模块ID | 1 |
| name | string | 否 | 名称 | "xxx报表" |
| alias | string | 否 | 别名 | "xxx报表" |
| merchantIndustry | string | 否 | 商户行业 【 COMPLEX : 大型购物中心;多种经营联合体;跨行业经营集团 TRADE : 商贸经营企业 RETAIL : 商超经营企业 RESTAURANT : 餐饮企业 FOOD : 餐饮企业 ENERGY : 加油、气、店站 OIL : 加油、气、店站 CRUISE : 邮轮旅游 PLAYGROUND : 游乐场综合体 MANUFACTURING : 生产制造业 】 | "COMPLEX" |
| companyType | string | 否 | 公司类型 【 MERCHANT : 商户 ENTERPRISE : 企业 CENTER_WAREHOUSE : 中央仓 EMPTY : 无任何管理功能 AREA : 区域 AREA_HEADQUARTER : 区域总部 AREA_WAREHOUSE : 区域仓库 GROUPS : 分组 PORT : 港口 SHIP_PORT : 船舶港口 AIR_PORT : 航空港口 STORE : 门店 MALL : 商场 AMUSEMENT_PARKS : 游乐园 SHOP : 商铺 CRUISE : 邮轮 SHIP : 货船 AIRPLANE : 飞机 HOTEL : 酒店 STATION : 站 THEATER : 影剧院 FACTORY : 工厂 】 | "STORE" |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| type | string | 否 | 类型 【 EXCEL : 文档 BAR_CHART : 柱状图 PIE_CHART : 饼状图 LINE_CHART : 折线图 OTHER : 其他 】 | "EXCEL" |
| useType | string | 否 | 用途类型 【 DASHBOARD : 仪表盘 REPORT : 报表 DOCUMENT : 单据 】 | "DASHBOARD" |
| active | boolean | 否 | 是否可用 | true |
| description | string | 否 | 描述 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysReport com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.report.entity.SysReport
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysReport | 否 | | |
PUT
/erp/api/report/update/view-config/{reportViewConfigId}
系统报表管理接口
修改系统报表展示配置接口
OperationId: updateReportViewConfig
调用方法
PUT /erp/api/report/update/view-config/{reportViewConfigId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| reportViewConfigId | path | 是 | integer(int64) | 报表ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateReportViewConfigDTO com.leadwaycloud.manager.business.report.dto.UpdateReportViewConfigDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| viewConfig | string | 否 | 报表视图配置 | |
| apiId | integer(int64) | 否 | 报表获取数据的系统API | 1 |
| apiPath | string | 否 | 系统接口路径 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysReportViewConfig com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.report.entity.SysReportViewConfig
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysReportViewConfig | 否 | | |
PUT
/erp/api/model/update/{id}
模块管理接口
修改模块接口
OperationId: update_5
调用方法
PUT /erp/api/model/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateModelDTO com.leadwaycloud.manager.business.model.dto.UpdateModelDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 否 | 编号 | "HR" |
| name | string | 否 | 名称 | "认识" |
| active | boolean | 否 | 是否可用 | true |
| description | string | 否 | 描述 | |
| version | string | 否 | 版本编号 | |
| image | string | 否 | 图片 | |
| appId | integer(int64) | 否 | sys_app.id | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysModel com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.model.entity.SysModel
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysModel | 否 | | |
PUT
/erp/api/merchant/update/{id}
商户管理接口
修改商户接口
OperationId: update_6
调用方法
PUT /erp/api/merchant/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateMerchantDTO com.leadwaycloud.manager.business.merchant.dto.UpdateMerchantDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 否 | 商户代号 | "lwc" |
| abbreviation | string | 否 | 简称 | "立威云" |
| fullName | string | 否 | 全称(用作初始化创建公司) | "成都立威云科技有限公司" |
| status | string | 否 | 状态 【 OPEN : 开放的 CLOSE : 关闭的 】 | "OPEN" |
| email | string | 否 | 联系邮箱(用作初始化创建账号) | "sale@leadwaycloud.com" |
| phone | string | 否 | 联系电话 | |
| address | string | 否 | 联系地址 | |
| logo | string | 否 | 图标 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResMerchant com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.merchant.entity.ResMerchant
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResMerchant | 否 | | |
PUT
/erp/api/merchant/update-config/{id}
商户管理接口
修改商户配置接口
OperationId: updateConfig
调用方法
PUT /erp/api/merchant/update-config/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateMerchantConfigDTO com.leadwaycloud.manager.business.merchant.dto.UpdateMerchantConfigDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| expireDate | string | 否 | 过期日期 | "2029-11-30" |
| userCount | integer(int32) | 否 | 用户数量 | 1 |
| posCount | integer(int32) | 否 | 机台数量 | 1 |
| modelIdList | integer(int64)[] | 否 | 模块ID | [1] |
| otherConfig | string | 否 | 其他配置(json字符串) | "{}" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResMerchant com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.merchant.entity.ResMerchant
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResMerchant | 否 | | |
PUT
/erp/api/merchant/reload/initial-role-function/{id}
商户管理接口
重新加载商户下所有公司初始角色功能接口
OperationId: reloadInitialRoleFunction
异步接口
调用方法
PUT /erp/api/merchant/reload/initial-role-function/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 商户ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
PUT
/erp/api/merchant/manual-execution/init-data/{id}
商户管理接口
手工处理商户初始化接口
OperationId: manualExecutionInitData
调用方法
PUT /erp/api/merchant/manual-execution/init-data/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 商户初始化数据ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
PUT
/erp/api/im-template-msg/update/{id}
即时通讯消息模版管理接口
修改通讯消息模版接口
OperationId: update_8
调用方法
PUT /erp/api/im-template-msg/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 报表ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: IMMsgTemplateDTO com.leadwaycloud.manager.business.im.msg.template.dto.IMMsgTemplateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 否 | 编号(没提供,后端会以过UUID的方式生成) | |
| name | string | 是 | 名称 | "会议邀请" |
| config | string | 是 | 模版消息配置 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: IMMsgTemplate com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.im.msg.template.entity.IMMsgTemplate
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMMsgTemplate | 否 | | |
PUT
/erp/api/function/update/{id}
功能管理接口
修改功能接口
OperationId: update_9
调用方法
PUT /erp/api/function/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateFunctionDTO com.leadwaycloud.manager.business.function.dto.UpdateFunctionDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| name | string | 否 | 名称 | |
| webMenuLevel | integer(int32) | 否 | 页面菜单级别 | 1 |
| webType | string | 否 | 页面类型 | |
| webRouter | string | 否 | 页面路由 | |
| index | integer(int32) | 否 | 页面渲染顺序 | 1 |
| description | string | 否 | 描述 | |
| buttonType | string | 否 | 按钮类型 | |
| modelId | integer(int64) | 否 | 模块ID | 1 |
| menuId | integer(int64) | 否 | 菜单ID | 1 |
| parentFunctionId | integer(int64) | 否 | 上级功能ID | 1 |
| appId | integer(int64) | 否 | sys_app.id | |
| matchApiList | FunctionMatchApiBO[] | 否 | 匹配的API | 1 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysFunction com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.function.entity.SysFunction
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysFunction | 否 | | |
PUT
/erp/api/express/update/{id}
快递公司管理接口
修改快递公司接口
OperationId: update_10
调用方法
PUT /erp/api/express/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateExpressDTO com.leadwaycloud.manager.business.express.dto.UpdateExpressDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 否 | 参数code | "ems" |
| name | string | 否 | 名称 | "EMS快递" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysExpress com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.express.entity.SysExpress
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysExpress | 否 | | |
PUT
/erp/api/device-command/update/{id}
系统设备指令管理接口
修改系统设备指令接口
OperationId: update_11
调用方法
PUT /erp/api/device-command/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
Content-Type: application/json 必填: 是 类型: UpdateDeviceCommandDTO com.leadwaycloud.manager.business.device.command.dto.UpdateDeviceCommandDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| brand | string | 否 | 品牌 | "Epson" |
| model | string | 否 | 型号 | "TM-T70" |
| type | string | 否 | 设备类型 【 PRINTER : 打印机 】 | "PRINTER" |
| command | DeviceCommandBO[] | 否 | 指令集 | [{"name":"切纸","code":"PARTIAL_CUT","command":"0x1D,0x56,0x00","description":"用作执行打印切纸动作"}] |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysDeviceCommand com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.device.command.entity.SysDeviceCommand
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysDeviceCommand | 否 | | |
PUT
/erp/api/currency/update/{id}
货币管理接口
修改货币接口
OperationId: update_12
调用方法
PUT /erp/api/currency/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateCurrencyDTO com.leadwaycloud.manager.business.currency.dto.UpdateCurrencyDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 否 | 编号 | "CNY" |
| name | string | 否 | 名称 | "人民币" |
| symbol | string | 否 | 符号 | "¥" |
| image | string | 否 | 图片 | |
| rounding | integer(int32) | 否 | 四舍五入精度 | 2 |
| active | boolean | 否 | 是否可用 | true |
| calcRate | boolean | 否 | 是否计算汇率 | true |
| calcRateUnit | number(double) | 否 | 汇率计算单位 | 100 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysCurrency com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.currency.entity.SysCurrency
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysCurrency | 否 | | |
PUT
/erp/api/currency/synchronize/currency-rate
货币管理接口
同步货币汇率接口
OperationId: synchronizeCurrencyRate
此接口为异步接口
调用方法
PUT /erp/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
/erp/api/company/update/{id}
商户公司管理接口
修改公司接口
OperationId: update_13
调用方法
PUT /erp/api/company/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateCompanyDTO com.leadwaycloud.manager.business.company.dto.UpdateCompanyDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 否 | 公司编号(仅允许字母和数字) | "CD01" |
| otherCode | string | 否 | 其他编号 | "AAAA-01" |
| status | string | 否 | 状态 【 IN_OPERATION : 营业中 TO_BE_OPENED : 待开业 PREPARATION : 筹备中 】 | "IN_OPERATION" |
| parentCompanyId | integer(int64) | 否 | 上级公司ID | 1 |
| name | string | 否 | 名称 | |
| image | string | 否 | 图片 | |
| initConfig | string | 否 | 公司配置是否初始化 | "false" |
| latLon | string | 否 | 经纬度(纬度,经度) | "104.064737,30.547256" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResCompany com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.company.entity.ResCompany
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResCompany | 否 | | |
PUT
/erp/api/company/reload/initial-role-function/{id}
商户公司管理接口
重新加载公司初始角色功能接口
OperationId: reloadInitialRoleFunction_1
调用方法
PUT /erp/api/company/reload/initial-role-function/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 公司ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
PUT
/erp/api/application/update/{id}
系统应用管理接口
修改应用接口
OperationId: update_14
调用方法
PUT /erp/api/application/update/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | | |
请求体
Content-Type: application/json 必填: 是 类型: UpdateApplicationDTO com.leadwaycloud.manager.business.application.dto.UpdateApplicationDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| merchantIndustry | string | 是 | 商户行业 【 COMPLEX : 大型购物中心;多种经营联合体;跨行业经营集团 TRADE : 商贸经营企业 RETAIL : 商超经营企业 RESTAURANT : 餐饮企业 FOOD : 餐饮企业 ENERGY : 加油、气、店站 OIL : 加油、气、店站 CRUISE : 邮轮旅游 PLAYGROUND : 游乐场综合体 MANUFACTURING : 生产制造业 】 | "COMPLEX" |
| companyType | string | 是 | 公司类型 【 MERCHANT : 商户 ENTERPRISE : 企业 CENTER_WAREHOUSE : 中央仓 EMPTY : 无任何管理功能 AREA : 区域 AREA_HEADQUARTER : 区域总部 AREA_WAREHOUSE : 区域仓库 GROUPS : 分组 PORT : 港口 SHIP_PORT : 船舶港口 AIR_PORT : 航空港口 STORE : 门店 MALL : 商场 AMUSEMENT_PARKS : 游乐园 SHOP : 商铺 CRUISE : 邮轮 SHIP : 货船 AIRPLANE : 飞机 HOTEL : 酒店 STATION : 站 THEATER : 影剧院 FACTORY : 工厂 】 | "STORE" |
| name | string | 是 | 名称 | "收银服务" |
| image | string | 是 | 图片 | |
| description | string | 否 | 描述 | |
| active | boolean | 否 | 是否可用 | true |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysApplication com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.application.entity.SysApplication
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysApplication | 否 | | |
PUT
/erp/api/app/withdraw/{appVersionId}
APP管理接口
撤回APP版本接口
OperationId: withdrawAppVersion
调用方法
PUT /erp/api/app/withdraw/{appVersionId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| appVersionId | path | 是 | integer(int64) | APP 版本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 | 否 | 返回数据 | |
PUT
/erp/api/app/update/{appId}
APP管理接口
修改APP信息接口
OperationId: updateApp
调用方法
PUT /erp/api/app/update/{appId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| appId | path | 是 | integer(int64) | APP ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateAppDTO com.leadwaycloud.manager.business.app.dto.UpdateAppDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| name | string | 否 | 名称 | "Slim POS" |
| image | string | 否 | 照片 | "xxx" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
PUT
/erp/api/app/release/{appVersionId}
APP管理接口
发布APP版本接口
OperationId: releaseAppVersion
调用方法
PUT /erp/api/app/release/{appVersionId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| appVersionId | path | 是 | integer(int64) | APP 版本ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UploadAppPackageDTO com.leadwaycloud.manager.business.app.dto.UploadAppPackageDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| releaseNote | string | 是 | 版本发布信息 | "xxxx" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
PUT
/erp/api/app/release/sandbox/{appVersionId}
APP管理接口
发布APP沙盒版本接口
OperationId: releaseSandboxAppVersion
调用方法
PUT /erp/api/app/release/sandbox/{appVersionId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| appVersionId | path | 是 | integer(int64) | APP 版本ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UploadAppPackageDTO com.leadwaycloud.manager.business.app.dto.UploadAppPackageDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| releaseNote | string | 是 | 版本发布信息 | "xxxx" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
PUT
/erp/api/api/open/{id}
系统API管理接口
开放系统API接口
OperationId: open
调用方法
PUT /erp/api/api/open/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
PUT
/erp/api/api/close/{id}
系统API管理接口
关闭系统API接口
OperationId: close
调用方法
PUT /erp/api/api/close/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
PUT
/erp/api/address/upgrade/administrative-divisions
地址管理接口
升级五级联动数据接口
OperationId: upgradeAdministrativeDivisions
后台会爬取国家统计局网站的信息(异步接口)
调用方法
PUT /erp/api/address/upgrade/administrative-divisions
参数
无
请求体
Content-Type: application/json 必填: 是 类型: UpgradeAddressDTO com.leadwaycloud.manager.business.address.dto.UpgradeAddressDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| name | string | 是 | 名称 | "中国" |
| countryCode | string | 是 | 国际代码 | "CN" |
| language | string | 是 | 语言 | "zh_CN" |
| updateYear | integer(int32) | 是 | 更新年度 | 2020 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
PUT
/erp/api/address/update/administrative-divisions/{id}
地址管理接口
修改五级联动数据接口
OperationId: updateAdministrativeDivisions
调用方法
PUT /erp/api/address/update/administrative-divisions/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 地址数据ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateAddressDTO com.leadwaycloud.manager.business.accounting.dto.UpdateAddressDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| type | string | 是 | 类型 【 COUNTRY : 国家/地区 PROVINCE : 省/州/自治区/直辖市 CITY : 城市 AREA : 区/县 STREET : 街道/镇 】 | "COUNTRY" |
| name | string | 否 | 名称 | "中华人民共和国" |
| enName | string | 否 | 英文名称(非国家/省份/城市类型时,可不提供) | "the People's Republic of China" |
| shortName | string | 否 | 中文简称(非国家类型时,可不提供) | "中国" |
| code | string | 否 | 代码 | "CHN" |
| shortCode | string | 否 | 代码(两码)。非国家类型时,可不提供 | "CN" |
| language | string | 否 | 语言。非国家类型时,可不提供 | "zh_CN" |
| timezone | string | 否 | 时区。非国家类型时,可不提供 | "GMT+08:00" |
| parentId | integer(int64) | 否 | 上一级ID。国家类型时,可不提供 | 1 |
| longitude | number(double) | 否 | 经度。非国家/省份类型时,可不提供 | 104.195397 |
| latitude | number(double) | 否 | 纬度。非国家/省份类型时,可不提供 | 35.86166 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
PUT
/erp/api/accounting/update/type/{accountingTypeId}
会计科目管理接口
修改会计科目类别接口
OperationId: updateAccountingType
调用方法
PUT /erp/api/accounting/update/type/{accountingTypeId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| accountingTypeId | path | 是 | integer(int64) | 会计科目类别ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateAccountingTypeDTO com.leadwaycloud.manager.business.accounting.dto.UpdateAccountingTypeDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 否 | 编号(纯数字) | "1000" |
| name | string | 否 | 名称 | "资产类" |
| enName | string | 否 | 英文名称 | "Assets" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysAccountingType com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.accounting.entity.SysAccountingType
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysAccountingType | 否 | | |
PUT
/erp/api/accounting/update/title/{accountingTitleId}
会计科目管理接口
修改会计科目接口
OperationId: updateAccountingTitle
调用方法
PUT /erp/api/accounting/update/title/{accountingTitleId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| accountingTitleId | path | 是 | integer(int64) | 会计科目ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: UpdateAccountingTitleDTO com.leadwaycloud.manager.business.accounting.dto.UpdateAccountingTitleDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 否 | 编号 | "1001" |
| name | string | 否 | 名称 | "库存现金" |
| enName | string | 否 | 英文名称 | "Cash" |
| scope | string | 否 | 会计科目使用范围 | |
| accountingTypeId | integer(int64) | 否 | 科目类型ID | 1 |
| allowBillUpdateAmount | boolean | 否 | 是否允许在收/付款单中修改金额 | true |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysAccountingTitle com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.accounting.entity.SysAccountingTitle
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysAccountingTitle | 否 | | |
PUT
/api/sys/property/update
系统公用属性
编辑系统属性
OperationId: update_15
调用方法
PUT /api/sys/property/update
参数
无
请求体
Content-Type: application/json 必填: 是 类型: SysPropertyDTO$UpdateDTO com.leadwaycloud.manager.business.property.dto.SysPropertyDTO$UpdateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| updateList | SysPropertyDTO$AddDTO[] | 否 | 编辑数据集合 | |
| deleteIdList | 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
/sys/api/user/registration
用户管理
账号注册接口
OperationId: registration
调用方法
POST /sys/api/user/registration
参数
无
请求体
Content-Type: application/json 必填: 是 类型: CreateUserDTO com.leadwaycloud.manager.business.manager.dto.CreateUserDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| account | string | 是 | 账号 | "admin" |
| password | string | 是 | 密码 | "1qazxsw" |
| name | string | 是 | 名称 | "管理员" |
| image | string | 否 | 头像 | |
| email | string | 是 | 邮箱 | "demo@leadwaycloud.com" |
| phone | string | 否 | 电话 | "0288888888" |
| mobilePhone | string | 否 | 手机 | "13888888888" |
| address | string | 否 | 地址 | "四川省成都市" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: ManagerUser com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.manager.entity.ManagerUser
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ManagerUser | 否 | | |
POST
/sys/api/token-reflash
登录管理
token刷新接口
OperationId: tokenReflash
调用方法
POST /sys/api/token-reflash
参数
无
请求体
Content-Type: application/json 必填: 是 类型: LoginDTO com.leadwaycloud.manager.business.manager.dto.LoginDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| account | string | 是 | 账号 | "admin" |
| password | string | 是 | 密码 | "MD5(1qazxsw)" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: String com.leadwaycloud.core.model.RJava.lang.String
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | string | 否 | 返回数据 | |
POST
/sys/api/logout
登出管理
登出接口
OperationId: logout
调用方法
POST /sys/api/logout
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/sys/api/login
登录管理
登录接口
OperationId: login
调用方法
POST /sys/api/login
参数
无
请求体
Content-Type: application/json 必填: 是 类型: LoginDTO com.leadwaycloud.manager.business.manager.dto.LoginDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| account | string | 是 | 账号 | "admin" |
| password | string | 是 | 密码 | "MD5(1qazxsw)" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: ManagerUser com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.manager.entity.ManagerUser
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ManagerUser | 否 | | |
POST
/sys/api/captcha/send-email-captcha/{account}
验证码管理
发送账号验证码接口
OperationId: sendCaptchaForAccount
验证码3分钟过期
调用方法
POST /sys/api/captcha/send-email-captcha/{account}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| account | path | 是 | string | 账号 | "kunliang.zeng@leadwaycloud.com" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/server-manager/upload/server-file/to-appoint-directory
服务管理接口
上传服务文件到指定目录接口
OperationId: uploadServerFileToAppointDirectory
调用方法
POST /server-manager/upload/server-file/to-appoint-directory
参数
无
请求体
Content-Type: multipart/form-data 必填: 否 类型: object
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| arg0 | UploadFileDTO | 是 | | |
| serverFile | string(binary) | 是 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
POST
/server-manager/execute/non-interactive/command
服务管理接口
执行非交互性指令接口
OperationId: executeNonInteractiveCommand
不支持在命令执行过程中,进行控制台指令输入的操作指令
调用方法
POST /server-manager/execute/non-interactive/command
参数
无
请求体
Content-Type: application/json 必填: 是 类型: ExecCommandDTO com.leadwaycloud.manager.business.manager.dto.ExecCommandDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| host | string | 是 | 远程主机地址 | |
| port | integer(int32) | 是 | SSH端口号 | |
| username | string | 是 | 登录用户名 | |
| password | string | 是 | 登录密码 | |
| connectionTimeout | integer(int32) | 是 | 连接超时时间(毫秒) | |
| executeTimeout | integer(int32) | 是 | 命令执行超时时间(毫秒) | |
| commandList | string[] | 是 | 命令集 | |
响应
状态码: 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
/erp/api/version-manager/add
版本号管理(作废)
添加版本接口
OperationId: add
已废弃
调用方法
POST /erp/api/version-manager/add
参数
无
请求体
Content-Type: application/json 必填: 是 类型: SysVersionDTO$AddDTO com.leadwaycloud.monitor.model.dto.SysVersionDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| serviceName | string | 否 | | |
| code | string | 否 | | |
| deployTime | string(date-time) | 否 | | |
| content | string | 否 | | |
响应
状态码: 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 | 否 | | |
POST
/erp/api/uom/upload
计量单位管理接口
导入计量单位
OperationId: uploadMultipartFile
调用方法
POST /erp/api/uom/upload
参数
无
请求体
Content-Type: multipart/form-data 必填: 否 类型: object
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| importFile | string(binary) | 是 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
POST
/erp/api/uom/add
计量单位管理接口
添加计量单位接口
OperationId: add_1
调用方法
POST /erp/api/uom/add
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddUomDTO com.leadwaycloud.manager.business.uom.dto.AddUomDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 是 | 编号 | "1" |
| name | string | 是 | 名称 | "公斤" |
| symbol | string | 是 | 符号 | "kg" |
| subUomId | integer(int64) | 否 | 下级计量单位ID | 2 |
| ratio | number(double) | 否 | 换算率 | 1000 |
| shortName | string | 否 | 简称 | |
| isoShortName | string | 否 | ISO简称 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysUom com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.uom.entity.SysUom
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysUom | 否 | | |
POST
/erp/api/sys-printer-template/add/report
系统打印模版管理接口
添加系统报表打印模版接口
OperationId: add_2
调用方法
POST /erp/api/sys-printer-template/add/report
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddSysReportPrinterTemplateConfigDTO com.leadwaycloud.manager.business.printer.template.dto.AddSysReportPrinterTemplateConfigDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| name | string | 是 | 名称 | |
| description | string | 否 | 描述 | |
| reportId | integer(int64) | 是 | 报表ID | 1 |
| apiId | integer(int64) | 是 | 打印模板对应的数据源API ID | 1 |
| configData | string | 是 | 打印模版配置 | |
| merchantId | integer(int64) | 否 | 商户ID(专门为该商户设计时需提供) | 1 |
| company | integer(int64)[] | 否 | 公司(设置了公司，必须提供商户ID) | |
| targetType | string | 否 | 模版目标对象类型 【 SUPPLIER : 供应商 CUSTOMER : 客户 AGENT : 代理商 CARRIER : 承运商 PRODUCER : 生产商 MEMBER : 会员 】 | |
| targets | integer(int64)[] | 否 | 模版目标对象 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysPrinterTemplateConfig com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.printer.template.entity.SysPrinterTemplateConfig
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysPrinterTemplateConfig | 否 | | |
POST
/erp/api/sys-printer-template/add/receipt
系统打印模版管理接口
添加系统单据打印模版接口
OperationId: add_3
调用方法
POST /erp/api/sys-printer-template/add/receipt
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddSysReceiptPrinterTemplateConfigDTO com.leadwaycloud.manager.business.printer.template.dto.AddSysReceiptPrinterTemplateConfigDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| name | string | 是 | 名称 | |
| description | string | 否 | 描述 | |
| receiptCode | string | 是 | 单据代号 | |
| apiId | integer(int64) | 否 | 打印模板对应的数据源API ID | 1 |
| configData | string | 是 | 打印模版配置 | |
| merchantId | integer(int64) | 否 | 商户ID(专门为该商户设计时需提供) | 1 |
| company | integer(int64)[] | 否 | 公司(设置了公司，必须提供商户ID) | |
| targetType | string | 否 | 模版目标对象类型 【 SUPPLIER : 供应商 CUSTOMER : 客户 AGENT : 代理商 CARRIER : 承运商 PRODUCER : 生产商 MEMBER : 会员 】 | |
| targets | integer(int64)[] | 否 | 模版目标对象 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysPrinterTemplateConfig com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.printer.template.entity.SysPrinterTemplateConfig
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysPrinterTemplateConfig | 否 | | |
POST
/erp/api/sys-printer-template/add/label
系统打印模版管理接口
添加系统标签打印模版接口
OperationId: add_4
调用方法
POST /erp/api/sys-printer-template/add/label
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddSysLabelPrinterTemplateConfigDTO com.leadwaycloud.manager.business.printer.template.dto.AddSysLabelPrinterTemplateConfigDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| name | string | 是 | 名称 | |
| description | string | 否 | 描述 | |
| apiId | integer(int64) | 是 | 打印模板对应的数据源API ID | 1 |
| configData | string | 是 | 打印模版配置 | |
| merchantId | integer(int64) | 否 | 商户ID(专门为该商户设计时需提供) | 1 |
| company | integer(int64)[] | 否 | 公司(设置了公司，必须提供商户ID) | |
| targetType | string | 否 | 模版目标对象类型 【 SUPPLIER : 供应商 CUSTOMER : 客户 AGENT : 代理商 CARRIER : 承运商 PRODUCER : 生产商 MEMBER : 会员 】 | |
| targets | integer(int64)[] | 否 | 模版目标对象 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysPrinterTemplateConfig com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.printer.template.entity.SysPrinterTemplateConfig
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysPrinterTemplateConfig | 否 | | |
POST
/erp/api/sys-import-template/upload/{type}
系统导入模版管理接口
上传系统导入模版接口
OperationId: uploadMultipartFile_1
调用方法
POST /erp/api/sys-import-template/upload/{type}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| type | path | 是 | string | 类型 | |
| version | query | 否 | string | 版本 | |
请求体
Content-Type: multipart/form-data 必填: 否 类型: object
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| importTemplateFile | string(binary) | 是 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysImportTemplate com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.imp.template.entity.SysImportTemplate
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysImportTemplate | 否 | | |
POST
/erp/api/setting/add
系统参数管理接口
添加系统参数接口
OperationId: add_5
调用方法
POST /erp/api/setting/add
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddSettingDTO com.leadwaycloud.manager.business.setting.dto.AddSettingDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| scope | string | 是 | 参数作用域 【 MERCHANT : 商户 COMPANY : 公司 】 | "MERCHANT" |
| scopeValue | string | 是 | scope=MERCHANT 则为商户行业 scope=COMPANY 则为公司类型 | "COMPLEX" |
| type | string | 是 | 参数设置类型 【 GLOBAL : 全局 MODEL : 模块 】 | "GLOBAL" |
| typeValue | integer(int64) | 是 | 类型值(type=GLOBAL则为0 type=MODEL则为模块ID) | 0 |
| settingCode | string | 是 | 参数code | "CURRENCY_TYPE" |
| settingValue | string | 是 | 参数选择项(list的json数据格式) | "[\"MORE\",\"SINGLE\"]" |
| selectType | string | 是 | 参数选择类型 【 MORE : 多选 SINGLE : 单选 】 | "SINGLE" |
| description | string | 否 | 参数描述 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysSetting com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.setting.entity.SysSetting
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysSetting | 否 | | |
POST
/erp/api/sensitive-word/add/deny
敏感字管理接口
添加敏感词黑名单接口
OperationId: addDeny
调用方法
POST /erp/api/sensitive-word/add/deny
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddSensitiveWordDTO[] com.leadwaycloud.manager.business.sensitive.word.dto.AddSensitiveWordDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | AddSensitiveWordDTO[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
POST
/erp/api/sensitive-word/add/allow
敏感字管理接口
添加敏感词白名单接口
OperationId: addAllow
调用方法
POST /erp/api/sensitive-word/add/allow
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddSensitiveWordDTO[] com.leadwaycloud.manager.business.sensitive.word.dto.AddSensitiveWordDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | AddSensitiveWordDTO[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
POST
/erp/api/role/patch-add/user/{id}
商户角色管理接口
角色批量添加用户接口
OperationId: patchAddUser
调用方法
POST /erp/api/role/patch-add/user/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | integer(int64)[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResRole com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.role.entity.ResRole
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResRole | 否 | | |
POST
/erp/api/role/patch-add/function/{id}
商户角色管理接口
角色批量添加功能接口
OperationId: patchAddFunction
调用方法
POST /erp/api/role/patch-add/function/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | integer(int64)[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResRole com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.role.entity.ResRole
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResRole | 否 | | |
POST
/erp/api/report/add
系统报表管理接口
添加系统报表接口
OperationId: add_6
调用方法
POST /erp/api/report/add
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddReportDTO com.leadwaycloud.manager.business.report.dto.AddReportDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| modelId | integer(int64) | 是 | 所属模块ID | 1 |
| name | string | 是 | 名称 | "xxx报表" |
| alias | string | 否 | 别名 | "xxx报表" |
| merchantIndustry | string | 否 | 商户行业 【 COMPLEX : 大型购物中心;多种经营联合体;跨行业经营集团 TRADE : 商贸经营企业 RETAIL : 商超经营企业 RESTAURANT : 餐饮企业 FOOD : 餐饮企业 ENERGY : 加油、气、店站 OIL : 加油、气、店站 CRUISE : 邮轮旅游 PLAYGROUND : 游乐场综合体 MANUFACTURING : 生产制造业 】 | "COMPLEX" |
| companyType | string | 否 | 公司类型 【 MERCHANT : 商户 ENTERPRISE : 企业 CENTER_WAREHOUSE : 中央仓 EMPTY : 无任何管理功能 AREA : 区域 AREA_HEADQUARTER : 区域总部 AREA_WAREHOUSE : 区域仓库 GROUPS : 分组 PORT : 港口 SHIP_PORT : 船舶港口 AIR_PORT : 航空港口 STORE : 门店 MALL : 商场 AMUSEMENT_PARKS : 游乐园 SHOP : 商铺 CRUISE : 邮轮 SHIP : 货船 AIRPLANE : 飞机 HOTEL : 酒店 STATION : 站 THEATER : 影剧院 FACTORY : 工厂 】 | "STORE" |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| type | string | 是 | 类型 【 EXCEL : 文档 BAR_CHART : 柱状图 PIE_CHART : 饼状图 LINE_CHART : 折线图 OTHER : 其他 】 | "EXCEL" |
| useType | string | 是 | 用途类型 【 DASHBOARD : 仪表盘 REPORT : 报表 DOCUMENT : 单据 】 | "DASHBOARD" |
| description | string | 否 | 描述 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysReport com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.report.entity.SysReport
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysReport | 否 | | |
POST
/erp/api/report/add/view-config/{id}
系统报表管理接口
添加系统报表展示配置接口
OperationId: addReportViewConfig
调用方法
POST /erp/api/report/add/view-config/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 报表ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: AddReportViewConfigDTO com.leadwaycloud.manager.business.report.dto.AddReportViewConfigDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| viewConfig | string | 是 | 报表视图配置 | |
| apiId | integer(int64) | 否 | 报表获取数据的系统API | 1 |
| apiPath | string | 否 | 系统接口路径 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysReportViewConfig com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.report.entity.SysReportViewConfig
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysReportViewConfig | 否 | | |
POST
/erp/api/platform-version-manager/confirm-platform-version/{userId}
平台版本管理
确认平台版本信息
OperationId: confirmPlatformVersion
调用方法
POST /erp/api/platform-version-manager/confirm-platform-version/{userId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| userId | 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
/erp/api/platform-version-manager/add
平台版本管理
添加平台版本接口
OperationId: addPlatformVersion
调用方法
POST /erp/api/platform-version-manager/add
参数
无
请求体
Content-Type: application/json 必填: 是 类型: PlatformVersionDTO$AddPlatformVersionDTO com.leadwaycloud.manager.business.platform.version.dto.PlatformVersionDTO$AddPlatformVersionDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| version | string | 是 | 版本 | "1.0.0.1" |
| deployTime | string | 是 | 发布时间 | "2020-10-11 13:09:11" |
| modelVersionList | integer(int64) | 是 | 模块ID | 1 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysPlatformVersion com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.platform.version.entity.SysPlatformVersion
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysPlatformVersion | 否 | | |
POST
/erp/api/model/add
模块管理接口
添加模块接口
OperationId: add_7
调用方法
POST /erp/api/model/add
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddModelDTO com.leadwaycloud.manager.business.model.dto.AddModelDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 是 | 编号 | "HR" |
| name | string | 是 | 名称 | "认识" |
| description | string | 否 | 描述 | |
| version | string | 是 | 版本编号 | |
| image | string | 是 | 图片 | |
| appId | integer(int64) | 否 | sys_app.id | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysModel com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.model.entity.SysModel
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysModel | 否 | | |
POST
/erp/api/merchant/add
商户管理接口
添加商户接口
OperationId: add_8
调用方法
POST /erp/api/merchant/add
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddMerchantDTO com.leadwaycloud.manager.business.merchant.dto.AddMerchantDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 是 | 代号 | "lwc" |
| abbreviation | string | 是 | 简称 | "立威云" |
| fullName | string | 是 | 全称(用作初始化创建公司) | "成都立威云科技有限公司" |
| industry | string | 是 | 行业 【 COMPLEX : 大型购物中心;多种经营联合体;跨行业经营集团 TRADE : 商贸经营企业 RETAIL : 商超经营企业 RESTAURANT : 餐饮企业 FOOD : 餐饮企业 ENERGY : 加油、气、店站 OIL : 加油、气、店站 CRUISE : 邮轮旅游 PLAYGROUND : 游乐场综合体 MANUFACTURING : 生产制造业 】 | "COMPLEX" |
| currencyId | integer(int64) | 是 | 货币ID | 1 |
| email | string | 是 | 联系邮箱(用作初始化创建账号) | "sale@leadwaycloud.com" |
| phone | string | 否 | 联系电话 | |
| address | string | 否 | 联系地址 | |
| logo | string | 否 | 图标 | |
| expireDate | string | 是 | 过期日期 | "2029-11-30" |
| userCount | integer(int32) | 是 | 用户数量 | 1 |
| posCount | integer(int32) | 是 | 机台数量 | 1 |
| modelIdList | integer(int64)[] | 是 | 系统模块ID | [1] |
| otherConfig | string | 否 | 其他配置(json字符串) | "{}" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResMerchant com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.merchant.entity.ResMerchant
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResMerchant | 否 | | |
POST
/erp/api/merchant-init/add-sql
商户初始化管理接口
添加系统初始化商户(Sql)数据接口
OperationId: addForSql
调用方法
POST /erp/api/merchant-init/add-sql
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddInitMerchantForSqlDTO com.leadwaycloud.manager.business.merchant.dto.AddInitMerchantForSqlDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| merchantIndustry | string | 是 | 商户行业 【 COMPLEX : 大型购物中心;多种经营联合体;跨行业经营集团 TRADE : 商贸经营企业 RETAIL : 商超经营企业 RESTAURANT : 餐饮企业 FOOD : 餐饮企业 ENERGY : 加油、气、店站 OIL : 加油、气、店站 CRUISE : 邮轮旅游 PLAYGROUND : 游乐场综合体 MANUFACTURING : 生产制造业 】 | "COMPLEX" |
| index | integer(int32) | 是 | 初始化顺序 | 1 |
| sqlStr | string | 是 | sql语句 | "select * from res_company where id = ?" |
| paramList | object[] | 是 | sql参数 | [1] |
| description | string | 否 | 描述 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysInitMerchant com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.merchant.entity.SysInitMerchant
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysInitMerchant | 否 | | |
POST
/erp/api/merchant-init/add-interface
商户初始化管理接口
添加系统初始化商户(接口)数据接口
OperationId: addForInterface
调用方法
POST /erp/api/merchant-init/add-interface
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddInitMerchantForInterfaceDTO com.leadwaycloud.manager.business.merchant.dto.AddInitMerchantForInterfaceDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| merchantIndustry | string | 是 | 商户行业 【 COMPLEX : 大型购物中心;多种经营联合体;跨行业经营集团 TRADE : 商贸经营企业 RETAIL : 商超经营企业 RESTAURANT : 餐饮企业 FOOD : 餐饮企业 ENERGY : 加油、气、店站 OIL : 加油、气、店站 CRUISE : 邮轮旅游 PLAYGROUND : 游乐场综合体 MANUFACTURING : 生产制造业 】 | "COMPLEX" |
| index | integer(int32) | 是 | 初始化顺序 | 1 |
| interfacePath | string | 是 | 接口路径 | "http://api.leadwaycloud.com/erp/addAccount" |
| interfaceParam | SysInitHttpDTO | 是 | | |
| description | string | 否 | 描述 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysInitMerchant com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.merchant.entity.SysInitMerchant
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysInitMerchant | 否 | | |
POST
/erp/api/merchant-init/add-entity
商户初始化管理接口
添加系统初始化商户(实体类)数据接口
OperationId: addForEntity
调用方法
POST /erp/api/merchant-init/add-entity
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddInitMerchantForEntityDTO com.leadwaycloud.manager.business.merchant.dto.AddInitMerchantForEntityDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| merchantIndustry | string | 是 | 商户行业 【 COMPLEX : 大型购物中心;多种经营联合体;跨行业经营集团 TRADE : 商贸经营企业 RETAIL : 商超经营企业 RESTAURANT : 餐饮企业 FOOD : 餐饮企业 ENERGY : 加油、气、店站 OIL : 加油、气、店站 CRUISE : 邮轮旅游 PLAYGROUND : 游乐场综合体 MANUFACTURING : 生产制造业 】 | "COMPLEX" |
| index | integer(int32) | 是 | 初始化顺序 | 1 |
| packagePath | string | 是 | 实体类package路径 | "com.leadwaycloud.manager.domain.erp.ResMerchantModel" |
| entityJson | string | 是 | 实体类json数据 | "{}" |
| description | string | 否 | 描述 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysInitMerchant com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.merchant.entity.SysInitMerchant
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysInitMerchant | 否 | | |
POST
/erp/api/im-template-msg/add
即时通讯消息模版管理接口
添加通讯消息模版接口
OperationId: add_10
调用方法
POST /erp/api/im-template-msg/add
参数
无
请求体
Content-Type: application/json 必填: 是 类型: IMMsgTemplateDTO com.leadwaycloud.manager.business.im.msg.template.dto.IMMsgTemplateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 否 | 编号(没提供,后端会以过UUID的方式生成) | |
| name | string | 是 | 名称 | "会议邀请" |
| config | string | 是 | 模版消息配置 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: IMMsgTemplate com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.im.msg.template.entity.IMMsgTemplate
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMMsgTemplate | 否 | | |
POST
/erp/api/i18n/setting
国际化管理
设置国际化翻译字典接口
OperationId: settingTranslation
新增和修改都通过该接口处理,修改时需要提供单个语言、行业下的全量数据
调用方法
POST /erp/api/i18n/setting
参数
无
请求体
Content-Type: application/json 必填: 是 类型: TranslationDTO com.leadwaycloud.manager.business.i18n.dto.TranslationDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| langId | integer(int64) | 是 | 语言ID | 1 |
| industry | string | 是 | 商户类型 | |
| translationValue | object | 是 | 字典(map三级嵌套：application->module->key:value) | {"crm":{"common":{"K19419c77":"商品名称"}}} |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/erp/api/i18n/query/lang
国际化管理
查询语言接口
OperationId: queryLang
调用方法
POST /erp/api/i18n/query/lang
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResLang com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.i18n.entity.ResLang
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResLang[] | 否 | 返回数据 | |
POST
/erp/api/function/add
功能管理接口
添加功能接口
OperationId: add_11
调用方法
POST /erp/api/function/add
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddFunctionDTO com.leadwaycloud.manager.business.function.dto.AddFunctionDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| name | string | 是 | 名称 | |
| webMenuLevel | integer(int32) | 是 | 页面菜单级别 | 1 |
| webType | string | 是 | 页面类型 | |
| webRouter | string | 是 | 页面路由 | |
| index | integer(int32) | 是 | 页面渲染顺序 | 1 |
| description | string | 否 | 描述 | |
| buttonType | string | 否 | 按钮类型 | |
| modelId | integer(int64) | 是 | 模块ID | 1 |
| menuId | integer(int64) | 是 | 菜单ID | 1 |
| parentFunctionId | integer(int64) | 否 | 上级功能ID | 1 |
| appId | integer(int64) | 否 | sys_app.id | |
| matchApiList | FunctionMatchApiBO[] | 否 | 匹配的API | 1 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysFunction com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.function.entity.SysFunction
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysFunction | 否 | | |
POST
/erp/api/function/add/template
功能管理接口
添加功能模版接口
OperationId: addTemplate
调用方法
POST /erp/api/function/add/template
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddFunctionTemplateDTO com.leadwaycloud.manager.business.function.dto.AddFunctionTemplateDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| industry | string | 是 | 行业 【 COMPLEX : 大型购物中心;多种经营联合体;跨行业经营集团 TRADE : 商贸经营企业 RETAIL : 商超经营企业 RESTAURANT : 餐饮企业 FOOD : 餐饮企业 ENERGY : 加油、气、店站 OIL : 加油、气、店站 CRUISE : 邮轮旅游 PLAYGROUND : 游乐场综合体 MANUFACTURING : 生产制造业 】 | "COMPLEX" |
| type | string | 是 | 类型 【 MERCHANT : 商户 ENTERPRISE : 企业 CENTER_WAREHOUSE : 中央仓 EMPTY : 无任何管理功能 AREA : 区域 AREA_HEADQUARTER : 区域总部 AREA_WAREHOUSE : 区域仓库 GROUPS : 分组 PORT : 港口 SHIP_PORT : 船舶港口 AIR_PORT : 航空港口 STORE : 门店 MALL : 商场 AMUSEMENT_PARKS : 游乐园 SHOP : 商铺 CRUISE : 邮轮 SHIP : 货船 AIRPLANE : 飞机 HOTEL : 酒店 STATION : 站 THEATER : 影剧院 FACTORY : 工厂 】 | "STORE" |
| functionId | integer(int64) | 是 | 功能ID | 1 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysFunctionTemplate com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.function.entity.SysFunctionTemplate
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysFunctionTemplate | 否 | | |
POST
/erp/api/function/add-fast/template
功能管理接口
快速添加功能模版接口
OperationId: fastAddFunctionTemplate
调用方法
POST /erp/api/function/add-fast/template
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddFunctionTemplate2DTO com.leadwaycloud.manager.business.function.dto.AddFunctionTemplate2DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| industry | string | 是 | 行业 【 COMPLEX : 大型购物中心;多种经营联合体;跨行业经营集团 TRADE : 商贸经营企业 RETAIL : 商超经营企业 RESTAURANT : 餐饮企业 FOOD : 餐饮企业 ENERGY : 加油、气、店站 OIL : 加油、气、店站 CRUISE : 邮轮旅游 PLAYGROUND : 游乐场综合体 MANUFACTURING : 生产制造业 】 | "COMPLEX" |
| type | string | 是 | 类型 【 MERCHANT : 商户 ENTERPRISE : 企业 CENTER_WAREHOUSE : 中央仓 EMPTY : 无任何管理功能 AREA : 区域 AREA_HEADQUARTER : 区域总部 AREA_WAREHOUSE : 区域仓库 GROUPS : 分组 PORT : 港口 SHIP_PORT : 船舶港口 AIR_PORT : 航空港口 STORE : 门店 MALL : 商场 AMUSEMENT_PARKS : 游乐园 SHOP : 商铺 CRUISE : 邮轮 SHIP : 货船 AIRPLANE : 飞机 HOTEL : 酒店 STATION : 站 THEATER : 影剧院 FACTORY : 工厂 】 | "STORE" |
| modelIdList | integer(int64)[] | 是 | 模块ID集合 | [1] |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysFunctionTemplate com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.function.entity.SysFunctionTemplate
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysFunctionTemplate[] | 否 | 返回数据 | |
POST
/erp/api/function/add-batch/template
功能管理接口
添加功能模版(批量)接口
OperationId: batchAddTemplate
调用方法
POST /erp/api/function/add-batch/template
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddFunctionTemplate1DTO com.leadwaycloud.manager.business.function.dto.AddFunctionTemplate1DTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| industry | string | 是 | 行业 【 COMPLEX : 大型购物中心;多种经营联合体;跨行业经营集团 TRADE : 商贸经营企业 RETAIL : 商超经营企业 RESTAURANT : 餐饮企业 FOOD : 餐饮企业 ENERGY : 加油、气、店站 OIL : 加油、气、店站 CRUISE : 邮轮旅游 PLAYGROUND : 游乐场综合体 MANUFACTURING : 生产制造业 】 | "COMPLEX" |
| type | string | 是 | 类型 【 MERCHANT : 商户 ENTERPRISE : 企业 CENTER_WAREHOUSE : 中央仓 EMPTY : 无任何管理功能 AREA : 区域 AREA_HEADQUARTER : 区域总部 AREA_WAREHOUSE : 区域仓库 GROUPS : 分组 PORT : 港口 SHIP_PORT : 船舶港口 AIR_PORT : 航空港口 STORE : 门店 MALL : 商场 AMUSEMENT_PARKS : 游乐园 SHOP : 商铺 CRUISE : 邮轮 SHIP : 货船 AIRPLANE : 飞机 HOTEL : 酒店 STATION : 站 THEATER : 影剧院 FACTORY : 工厂 】 | "STORE" |
| functionIdList | integer(int64)[] | 是 | 功能ID集合 | [1] |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysFunctionTemplate com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.function.entity.SysFunctionTemplate
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysFunctionTemplate[] | 否 | 返回数据 | |
POST
/erp/api/express/add
快递公司管理接口
添加快递公司接口
OperationId: add_12
调用方法
POST /erp/api/express/add
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddExpressDTO com.leadwaycloud.manager.business.express.dto.AddExpressDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 是 | 参数code | "ems" |
| name | string | 是 | 名称 | "EMS快递" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysExpress com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.express.entity.SysExpress
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysExpress | 否 | | |
POST
/erp/api/device-command/add
系统设备指令管理接口
添加系统设备指令接口
OperationId: add_13
调用方法
POST /erp/api/device-command/add
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddDeviceCommandDTO com.leadwaycloud.manager.business.device.command.dto.AddDeviceCommandDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| brand | string | 是 | 品牌 | "Epson" |
| model | string | 是 | 型号 | "TM-T70" |
| type | string | 是 | 设备类型 【 PRINTER : 打印机 】 | "PRINTER" |
| command | DeviceCommandBO[] | 是 | 指令集 | [{"name":"切纸","code":"PARTIAL_CUT","command":"0x1D,0x56,0x00","description":"用作执行打印切纸动作"}] |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysDeviceCommand com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.device.command.entity.SysDeviceCommand
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysDeviceCommand | 否 | | |
POST
/erp/api/currency/add
货币管理接口
添加货币接口
OperationId: add_14
调用方法
POST /erp/api/currency/add
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddCurrencyDTO com.leadwaycloud.manager.business.currency.dto.AddCurrencyDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 是 | 编号 | "CNY" |
| name | string | 是 | 名称 | "人民币" |
| symbol | string | 是 | 符号 | "¥" |
| image | string | 否 | 图片 | |
| rounding | integer(int32) | 是 | 四舍五入精度 | 2 |
| calcRate | boolean | 是 | 是否计算汇率 | true |
| calcRateUnit | number(double) | 否 | 汇率计算单位 | 100 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysCurrency com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.currency.entity.SysCurrency
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysCurrency | 否 | | |
POST
/erp/api/company/manual-execution/init-data/{id}
商户公司管理接口
手工处理公司初始化接口
OperationId: manualExecutionInitData_1
调用方法
POST /erp/api/company/manual-execution/init-data/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 公司初始化数据ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
POST
/erp/api/company/add/{merchantId}
商户公司管理接口
添加公司接口
OperationId: add_15
调用方法
POST /erp/api/company/add/{merchantId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantId | path | 是 | integer(int64) | 公司ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: AddCompanyDTO com.leadwaycloud.manager.business.company.dto.AddCompanyDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 是 | 公司编号(仅允许字母和数字) | "CD01" |
| otherCode | string | 否 | 其他编号 | "AAAA-01" |
| name | string | 是 | 名称 | "成都立威云科技有限公司" |
| type | string | 是 | 类型 【 MERCHANT : 商户 ENTERPRISE : 企业 CENTER_WAREHOUSE : 中央仓 EMPTY : 无任何管理功能 AREA : 区域 AREA_HEADQUARTER : 区域总部 AREA_WAREHOUSE : 区域仓库 GROUPS : 分组 PORT : 港口 SHIP_PORT : 船舶港口 AIR_PORT : 航空港口 STORE : 门店 MALL : 商场 AMUSEMENT_PARKS : 游乐园 SHOP : 商铺 CRUISE : 邮轮 SHIP : 货船 AIRPLANE : 飞机 HOTEL : 酒店 STATION : 站 THEATER : 影剧院 FACTORY : 工厂 】 | "STORE" |
| parentCompanyId | integer(int64) | 是 | 上级公司ID | 1 |
| image | string | 否 | 图片 | |
| slogan | string | 否 | 公司标语 | "努力工作就是为了不工作" |
| addContactDTO | AddContactDTO | 否 | | |
| processResUserId | integer(int64) | 否 | 处理的商户用户ID | 1 |
| addFinanceInvoiceTitleDTO | AddFinanceInvoiceTitleDTO | 否 | | |
| currencyId | integer(int64) | 否 | 货币ID(未提供则默认为人民币) | 1 |
| latLon | string | 否 | 经纬度(纬度,经度) | "104.064737,30.547256" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResCompany com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.company.entity.ResCompany
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResCompany | 否 | | |
POST
/erp/api/company/add-internal-system/{merchantId}
商户公司管理接口
添加公司接口
OperationId: addByInternalSystem
内部系统调用
调用方法
POST /erp/api/company/add-internal-system/{merchantId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantId | path | 是 | integer(int64) | 公司ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: AddCompanyDTO com.leadwaycloud.manager.business.company.dto.AddCompanyDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 是 | 公司编号(仅允许字母和数字) | "CD01" |
| otherCode | string | 否 | 其他编号 | "AAAA-01" |
| name | string | 是 | 名称 | "成都立威云科技有限公司" |
| type | string | 是 | 类型 【 MERCHANT : 商户 ENTERPRISE : 企业 CENTER_WAREHOUSE : 中央仓 EMPTY : 无任何管理功能 AREA : 区域 AREA_HEADQUARTER : 区域总部 AREA_WAREHOUSE : 区域仓库 GROUPS : 分组 PORT : 港口 SHIP_PORT : 船舶港口 AIR_PORT : 航空港口 STORE : 门店 MALL : 商场 AMUSEMENT_PARKS : 游乐园 SHOP : 商铺 CRUISE : 邮轮 SHIP : 货船 AIRPLANE : 飞机 HOTEL : 酒店 STATION : 站 THEATER : 影剧院 FACTORY : 工厂 】 | "STORE" |
| parentCompanyId | integer(int64) | 是 | 上级公司ID | 1 |
| image | string | 否 | 图片 | |
| slogan | string | 否 | 公司标语 | "努力工作就是为了不工作" |
| addContactDTO | AddContactDTO | 否 | | |
| processResUserId | integer(int64) | 否 | 处理的商户用户ID | 1 |
| addFinanceInvoiceTitleDTO | AddFinanceInvoiceTitleDTO | 否 | | |
| currencyId | integer(int64) | 否 | 货币ID(未提供则默认为人民币) | 1 |
| latLon | string | 否 | 经纬度(纬度,经度) | "104.064737,30.547256" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResCompany com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.company.entity.ResCompany
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResCompany | 否 | | |
POST
/erp/api/company-init/add-sql
公司初始化管理接口
添加系统初始化公司(Sql)数据接口
OperationId: addForSql_1
调用方法
POST /erp/api/company-init/add-sql
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddInitCompanyForSqlDTO com.leadwaycloud.manager.business.company.dto.AddInitCompanyForSqlDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| merchantIndustry | string | 是 | 商户行业 【 COMPLEX : 大型购物中心;多种经营联合体;跨行业经营集团 TRADE : 商贸经营企业 RETAIL : 商超经营企业 RESTAURANT : 餐饮企业 FOOD : 餐饮企业 ENERGY : 加油、气、店站 OIL : 加油、气、店站 CRUISE : 邮轮旅游 PLAYGROUND : 游乐场综合体 MANUFACTURING : 生产制造业 】 | "COMPLEX" |
| companyType | string | 是 | 公司类型 【 MERCHANT : 商户 ENTERPRISE : 企业 CENTER_WAREHOUSE : 中央仓 EMPTY : 无任何管理功能 AREA : 区域 AREA_HEADQUARTER : 区域总部 AREA_WAREHOUSE : 区域仓库 GROUPS : 分组 PORT : 港口 SHIP_PORT : 船舶港口 AIR_PORT : 航空港口 STORE : 门店 MALL : 商场 AMUSEMENT_PARKS : 游乐园 SHOP : 商铺 CRUISE : 邮轮 SHIP : 货船 AIRPLANE : 飞机 HOTEL : 酒店 STATION : 站 THEATER : 影剧院 FACTORY : 工厂 】 | "STORE" |
| index | integer(int32) | 是 | 初始化顺序 | 1 |
| sqlStr | string | 是 | sql语句 | "select * from res_company where id = ?" |
| paramList | object[] | 是 | sql参数 | [1] |
| description | string | 否 | 描述 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysInitCompany com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.company.entity.SysInitCompany
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysInitCompany | 否 | | |
POST
/erp/api/company-init/add-interface
公司初始化管理接口
添加系统初始化公司(接口)数据接口
OperationId: addForInterface_1
调用方法
POST /erp/api/company-init/add-interface
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddInitCompanyForInterfaceDTO com.leadwaycloud.manager.business.company.dto.AddInitCompanyForInterfaceDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| merchantIndustry | string | 是 | 商户行业 【 COMPLEX : 大型购物中心;多种经营联合体;跨行业经营集团 TRADE : 商贸经营企业 RETAIL : 商超经营企业 RESTAURANT : 餐饮企业 FOOD : 餐饮企业 ENERGY : 加油、气、店站 OIL : 加油、气、店站 CRUISE : 邮轮旅游 PLAYGROUND : 游乐场综合体 MANUFACTURING : 生产制造业 】 | "COMPLEX" |
| companyType | string | 是 | 公司类型 【 MERCHANT : 商户 ENTERPRISE : 企业 CENTER_WAREHOUSE : 中央仓 EMPTY : 无任何管理功能 AREA : 区域 AREA_HEADQUARTER : 区域总部 AREA_WAREHOUSE : 区域仓库 GROUPS : 分组 PORT : 港口 SHIP_PORT : 船舶港口 AIR_PORT : 航空港口 STORE : 门店 MALL : 商场 AMUSEMENT_PARKS : 游乐园 SHOP : 商铺 CRUISE : 邮轮 SHIP : 货船 AIRPLANE : 飞机 HOTEL : 酒店 STATION : 站 THEATER : 影剧院 FACTORY : 工厂 】 | "STORE" |
| index | integer(int32) | 是 | 初始化顺序 | 1 |
| interfacePath | string | 是 | 接口路径 | "http://api.leadwaycloud.com/erp/addAccount" |
| interfaceParam | SysInitHttpDTO | 是 | | |
| description | string | 否 | 描述 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysInitCompany com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.company.entity.SysInitCompany
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysInitCompany | 否 | | |
POST
/erp/api/company-init/add-entity
公司初始化管理接口
添加系统初始化公司(实体类)数据接口
OperationId: addForEntity_1
调用方法
POST /erp/api/company-init/add-entity
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddInitCompanyForEntityDTO com.leadwaycloud.manager.business.company.dto.AddInitCompanyForEntityDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| merchantIndustry | string | 是 | 商户行业 【 COMPLEX : 大型购物中心;多种经营联合体;跨行业经营集团 TRADE : 商贸经营企业 RETAIL : 商超经营企业 RESTAURANT : 餐饮企业 FOOD : 餐饮企业 ENERGY : 加油、气、店站 OIL : 加油、气、店站 CRUISE : 邮轮旅游 PLAYGROUND : 游乐场综合体 MANUFACTURING : 生产制造业 】 | "COMPLEX" |
| companyType | string | 是 | 公司类型 【 MERCHANT : 商户 ENTERPRISE : 企业 CENTER_WAREHOUSE : 中央仓 EMPTY : 无任何管理功能 AREA : 区域 AREA_HEADQUARTER : 区域总部 AREA_WAREHOUSE : 区域仓库 GROUPS : 分组 PORT : 港口 SHIP_PORT : 船舶港口 AIR_PORT : 航空港口 STORE : 门店 MALL : 商场 AMUSEMENT_PARKS : 游乐园 SHOP : 商铺 CRUISE : 邮轮 SHIP : 货船 AIRPLANE : 飞机 HOTEL : 酒店 STATION : 站 THEATER : 影剧院 FACTORY : 工厂 】 | "STORE" |
| index | integer(int32) | 是 | 初始化顺序 | 1 |
| packagePath | string | 是 | 实体类package路径 | "com.leadwaycloud.manager.domain.erp.ResMerchantModel" |
| entityJson | string | 是 | 实体类json数据 | "{}" |
| description | string | 否 | 描述 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysInitCompany com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.company.entity.SysInitCompany
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysInitCompany | 否 | | |
POST
/erp/api/application/patch-add/api/{id}
系统应用管理接口
应用批量添加关联API接口
OperationId: batchAddRelevanceApi
调用方法
POST /erp/api/application/patch-add/api/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | integer(int64)[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysApplication com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.application.entity.SysApplication
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysApplication | 否 | | |
POST
/erp/api/application/add
系统应用管理接口
添加应用接口
OperationId: add_16
调用方法
POST /erp/api/application/add
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddApplicationDTO com.leadwaycloud.manager.business.application.dto.AddApplicationDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| merchantIndustry | string | 是 | 商户行业 【 COMPLEX : 大型购物中心;多种经营联合体;跨行业经营集团 TRADE : 商贸经营企业 RETAIL : 商超经营企业 RESTAURANT : 餐饮企业 FOOD : 餐饮企业 ENERGY : 加油、气、店站 OIL : 加油、气、店站 CRUISE : 邮轮旅游 PLAYGROUND : 游乐场综合体 MANUFACTURING : 生产制造业 】 | "COMPLEX" |
| companyType | string | 是 | 公司类型 【 MERCHANT : 商户 ENTERPRISE : 企业 CENTER_WAREHOUSE : 中央仓 EMPTY : 无任何管理功能 AREA : 区域 AREA_HEADQUARTER : 区域总部 AREA_WAREHOUSE : 区域仓库 GROUPS : 分组 PORT : 港口 SHIP_PORT : 船舶港口 AIR_PORT : 航空港口 STORE : 门店 MALL : 商场 AMUSEMENT_PARKS : 游乐园 SHOP : 商铺 CRUISE : 邮轮 SHIP : 货船 AIRPLANE : 飞机 HOTEL : 酒店 STATION : 站 THEATER : 影剧院 FACTORY : 工厂 】 | "STORE" |
| name | string | 是 | 名称 | "收银服务" |
| image | string | 是 | 图片 | |
| description | string | 否 | 描述 | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysApplication com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.application.entity.SysApplication
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysApplication | 否 | | |
POST
/erp/api/app/upload/app-version-file
APP管理接口
上传APP版本文件接口
OperationId: uploadAppVersionFile
不支持DMG安装文件上传(无法获取版本信息)
调用方法
POST /erp/api/app/upload/app-version-file
参数
无
请求体
Content-Type: multipart/form-data 必填: 否 类型: object
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| packageFile | string(binary) | 是 | | |
| heatPackageFile | string(binary) | 否 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
POST
/erp/api/app/upload/app-version-file/stupid
APP管理接口
上传APP版本文件接口
OperationId: uploadAppVersionFile_1
调用方法
POST /erp/api/app/upload/app-version-file/stupid
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| name | query | 是 | string | 名称 | "xxx" |
| code | query | 是 | string | 代号 | "xxx" |
| version | query | 是 | string | 版本 | "xxx" |
| buildVersion | query | 是 | string | 构建版本 | "xxx" |
| platform | query | 是 | string | 平台 Android:安卓 IOS:苹果手机 Windows:微软 OSX:苹果电脑 Linux:linux | "xxx" |
| framework | query | 否 | string | 架构 | "xxx" |
请求体
Content-Type: multipart/form-data 必填: 否 类型: object
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| packageFile | string(binary) | 是 | | |
| heatPackageFile | string(binary) | 否 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
POST
/erp/api/api/refresh
系统API管理接口
刷新服务API（swagger json地址）
OperationId: refreshServiceAPI
调用方法
POST /erp/api/api/refresh
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| url | query | 是 | string | 服务swagger api json路径(转码后的) | "https://api.leadwaycloud.com/lwc-cloud-erp-system/v2/api-docs-ext?group=%E9%A1%B9%E7%9B%AE%E4%B8%9A%E5%8A%A1%E6%8E%A5%E5%8F%A3" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysApi com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.api.entity.SysApi
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysApi[] | 否 | 返回数据 | |
POST
/erp/api/api/refresh/file
系统API管理接口
刷新服务API（swagger json文件）
OperationId: refreshServiceAPI_1
调用方法
POST /erp/api/api/refresh/file
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| serviceBasePath | query | 是 | string | 服务主路径 | "/lwc-cloud-erp-system" |
请求体
Content-Type: multipart/form-data 必填: 否 类型: object
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| file | string(binary) | 是 | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysApi com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.api.entity.SysApi
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysApi[] | 否 | 返回数据 | |
POST
/erp/api/address/update-province/latitude-and-longitude
地址管理接口
更新省份坐标数据接口
OperationId: updateProvinceLatitudeAndLongitude
根据打包在代码中的资料进行省份坐标设置，会对已经存在的坐标进行覆盖(异步接口)
调用方法
POST /erp/api/address/update-province/latitude-and-longitude
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
POST
/erp/api/address/query-address-by-ip
地址管理接口
根据ip查询地址接口
OperationId: queryAddressByIP
调用方法
POST /erp/api/address/query-address-by-ip
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| ipList | query | 是 | string | ip集合 | "221.10.33.75,110.191.218.22" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: IpAddressVO com.leadwaycloud.core.model.RJava.util.MapJava.lang.StringCom.leadwaycloud.manager.business.address.vo.IpAddressVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
POST
/erp/api/address/insert/other-country-address
地址管理接口
写入其他国家地址信息
OperationId: insertOtherCountryAddress
信息已经被打包在代码中(异步接口)
调用方法
POST /erp/api/address/insert/other-country-address
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
POST
/erp/api/address/init-country-data
地址管理接口
初始化国家信息接口
OperationId: initCountryData
根据打包在代码中的资料进行数据初始化，如果国家已经存在则更新部分数据(异步接口)
调用方法
POST /erp/api/address/init-country-data
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
POST
/erp/api/address/add/administrative-divisions
地址管理接口
增加五级联动数据接口
OperationId: addAdministrativeDivisions
调用方法
POST /erp/api/address/add/administrative-divisions
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddAddressDTO com.leadwaycloud.manager.business.address.dto.AddAddressDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| type | string | 是 | 类型 | "COUNTRY" |
| name | string | 是 | 名称 | "中华人民共和国" |
| enName | string | 否 | 英文名称(非国家/省份/城市类型时,可不提供) | "the People's Republic of China" |
| shortName | string | 否 | 中文简称(非国家类型时,可不提供) | "中国" |
| code | string | 是 | 代码 | "CHN" |
| shortCode | string | 否 | 代码(两码,非国家类型时,可不提供) | "CN" |
| language | string | 否 | 语言(非国家类型时,可不提供) | "zh_CN" |
| timezone | string | 否 | 时区(非国家类型时,可不提供) | "GMT+08:00" |
| parentId | integer(int64) | 否 | 上一级ID(国家类型时,可不提供) | 1 |
| longitude | number(double) | 否 | 经度(非国家/省份类型时,可不提供) | 104.195397 |
| latitude | number(double) | 否 | 纬度(非国家/省份类型时,可不提供) | 35.86166 |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
POST
/erp/api/accounting/add/type
会计科目管理接口
添加会计科目类别接口
OperationId: addAccountingType
调用方法
POST /erp/api/accounting/add/type
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddAccountingTypeDTO com.leadwaycloud.manager.business.accounting.dto.AddAccountingTypeDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 是 | 编号(纯数字) | "1000" |
| name | string | 是 | 名称 | "资产类" |
| enName | string | 否 | 英文名称 | "Assets" |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysAccountingType com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.accounting.entity.SysAccountingType
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysAccountingType | 否 | | |
POST
/erp/api/accounting/add/title
会计科目管理接口
添加会计科目接口
OperationId: addAccountingTitle
调用方法
POST /erp/api/accounting/add/title
参数
无
请求体
Content-Type: application/json 必填: 是 类型: AddAccountingTitleDTO com.leadwaycloud.manager.business.accounting.dto.AddAccountingTitleDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 是 | 编号 | "1001" |
| name | string | 是 | 名称 | "库存现金" |
| enName | string | 否 | 英文名称 | "Cash" |
| scope | string | 否 | 会计科目使用范围 | |
| accountingTypeId | integer(int64) | 是 | 科目类型ID | 1 |
| allowBillUpdateAmount | boolean | 否 | 是否允许在收/付款单中修改金额 | true |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysAccountingTitle com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.accounting.entity.SysAccountingTitle
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysAccountingTitle | 否 | | |
POST
/api/sys/property/add
系统公用属性
添加系统属性
OperationId: add_17
调用方法
POST /api/sys/property/add
参数
无
请求体
Content-Type: application/json 必填: 是 类型: SysPropertyDTO$AddDTO[] com.leadwaycloud.manager.business.property.dto.SysPropertyDTO$AddDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | SysPropertyDTO$AddDTO[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysProperty com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.property.entity.SysProperty
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysProperty[] | 否 | 返回数据 | |
GET
/sys/api/user/query/{id}
用户管理
查询用户(ID)接口
OperationId: query
调用方法
GET /sys/api/user/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ManagerUser com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.manager.entity.ManagerUser
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ManagerUser | 否 | | |
GET
/sys/api/user/query-page
用户管理
查询用户(分页)接口
OperationId: query_1
调用方法
GET /sys/api/user/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| account | query | 否 | string | 账号 | "admin" |
| name | query | 否 | string | 名称 | "管理员" |
| status | query | 否 | string | 状态 | "ACTIVE" |
| email | query | 否 | string | 邮箱 | "demo@leadwaycloud.com" |
| phone | query | 否 | string | 电话 | "0288888888" |
| mobilePhone | query | 否 | string | 手机 | 13888888888 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ManagerUser com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.manager.entity.ManagerUser
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ManagerUser | 否 | | |
GET
/sys/api/user/query-account/{account}
用户管理
查询用户(账号)接口
OperationId: query_2
调用方法
GET /sys/api/user/query-account/{account}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| account | path | 是 | string | 账号 | "erp_manager" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ManagerUser com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.manager.entity.ManagerUser
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ManagerUser | 否 | | |
GET
/erp/api/version-manager/query-page
版本号管理(作废)
查询版本(分页)接口
OperationId: pageQuery
已废弃
调用方法
GET /erp/api/version-manager/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| serviceName | query | 是 | string | 服务名称 | "lwc-cloud-erp-manager" |
请求体
无
响应
状态码: 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
/erp/api/version-manager/query-list
版本号管理(作废)
查询版本(列表)接口
OperationId: query_3
已废弃
调用方法
GET /erp/api/version-manager/query-list
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| serviceName | query | 是 | string | 服务名称 | "lwc-cloud-erp-manager" |
请求体
无
响应
状态码: 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
/erp/api/user/query/{id}
商户用户管理接口
查询用户(ID)接口
OperationId: query_4
调用方法
GET /erp/api/user/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResUser com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.user.entity.ResUser
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResUser | 否 | | |
GET
/erp/api/user/query-page
商户用户管理接口
查询用户(分页)接口
OperationId: pageQuery_1
调用方法
GET /erp/api/user/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| merchantId | query | 否 | long | 商户ID | 1 |
| companyId | query | 否 | long | 公司ID | 1 |
| status | query | 否 | string | 状态 | "ACTIVE" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResUser com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.user.entity.ResUser
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResUser | 否 | | |
GET
/erp/api/uom/query/{id}
计量单位管理接口
查询计量单位(ID)接口
OperationId: query_5
调用方法
GET /erp/api/uom/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysUom com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.uom.entity.SysUom
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysUom | 否 | | |
GET
/erp/api/uom/query-page
计量单位管理接口
查询计量单位(分页)接口
OperationId: pageQuery_2
调用方法
GET /erp/api/uom/query-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 | 简称 | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysUom com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.uom.entity.SysUom
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysUom | 否 | | |
GET
/erp/api/uom/query-code/{code}
计量单位管理接口
查询计量单位(编号)接口
OperationId: queryByCode
调用方法
GET /erp/api/uom/query-code/{code}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| code | path | 是 | string | 编号 | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysUom com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.uom.entity.SysUom
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysUom | 否 | | |
GET
/erp/api/sys-printer-template/query/{id}
系统打印模版管理接口
查询系统打印模版(ID)接口
OperationId: query_6
调用方法
GET /erp/api/sys-printer-template/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | query | 是 | integer(int64) | 参数ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysPrinterTemplateConfig com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.printer.template.entity.SysPrinterTemplateConfig
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysPrinterTemplateConfig | 否 | | |
GET
/erp/api/sys-printer-template/query/target
系统打印模版管理接口
查询目标对象数据接口
OperationId: queryTarget
调用方法
GET /erp/api/sys-printer-template/query/target
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| targetType | query | 是 | string | 目标对象类型 | "xxx" |
| merchantId | query | 是 | integer(int64) | 商户ID | 1 |
| companyId | query | 否 | integer(int64) | 公司ID | 1 |
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: TargetVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.printer.template.vo.TargetVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | TargetVO | 否 | | |
GET
/erp/api/sys-printer-template/query-page
系统打印模版管理接口
查询系统打印模版(分页)接口
OperationId: pageQuery_3
调用方法
GET /erp/api/sys-printer-template/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| name | query | 否 | string | 名称 | |
| status | query | 否 | string | 状态 | "DRAFT" |
| type | query | 否 | string | 类型 | "REPORT" |
| apiId | query | 否 | long | 打印模板对应的数据源API ID | 1 |
| merchantId | query | 否 | long | 商户ID | 1 |
| companyId | query | 否 | long | 公司ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysPrinterTemplateConfig com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.printer.template.entity.SysPrinterTemplateConfig
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysPrinterTemplateConfig | 否 | | |
GET
/erp/api/sys-operational-doc/query/{id}
系统操作文档管理接口
查询系统操作文档(ID)接口
OperationId: query_7
调用方法
GET /erp/api/sys-operational-doc/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 系统操作文档ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysOperationalDoc com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.operational.doc.entity.SysOperationalDoc
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysOperationalDoc | 否 | | |
GET
/erp/api/sys-operational-doc/query-page
系统操作文档管理接口
查询系统操作文档(分页)接口
OperationId: pageQuery_4
调用方法
GET /erp/api/sys-operational-doc/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| industry | query | 是 | string | 行业 | "COMPLEX" |
| modelId | query | 否 | long | 系统模块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.manager.business.operational.doc.entity.SysOperationalDoc
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysOperationalDoc | 否 | | |
GET
/erp/api/sys-import-template/query/{id}
系统导入模版管理接口
查询系统导入模版(ID)接口
OperationId: query_8
调用方法
GET /erp/api/sys-import-template/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 系统导入模版ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysImportTemplate com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.imp.template.entity.SysImportTemplate
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysImportTemplate | 否 | | |
GET
/erp/api/sys-import-template/query/type
系统导入模版管理接口
查询系统导入模版(类型)接口
OperationId: queryByType
调用方法
GET /erp/api/sys-import-template/query/type
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| type | query | 是 | string | 类型 | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysImportTemplate com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.imp.template.entity.SysImportTemplate
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysImportTemplate | 否 | | |
GET
/erp/api/sys-import-template/query-list
系统导入模版管理接口
查询系统导入模版(列表)接口
OperationId: queryList
调用方法
GET /erp/api/sys-import-template/query-list
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysImportTemplate com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.imp.template.entity.SysImportTemplate
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysImportTemplate[] | 否 | 返回数据 | |
GET
/erp/api/setting/query/{id}
系统参数管理接口
查询系统参数(ID)接口
OperationId: query_9
调用方法
GET /erp/api/setting/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysSetting com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.setting.entity.SysSetting
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysSetting | 否 | | |
GET
/erp/api/setting/query-page
系统参数管理接口
查询系统参数(分页)接口
OperationId: pageQuery_5
调用方法
GET /erp/api/setting/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| scope | query | 否 | string | 参数作用域 | "MERCHANT" |
| scopeValue | query | 否 | string | scope=MERCHANT 则为商户行业 scope=COMPANY 则为公司类型 | "COMPLEX" |
| type | query | 否 | string | 参数设置类型 | "GLOBAL" |
| typeValue | query | 否 | long | type=GLOBAL则为0 type=MODEL则为模块ID | 0 |
| settingCode | query | 否 | string | 参数code | "CURRENCY_TYPE" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysSetting com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.setting.entity.SysSetting
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysSetting | 否 | | |
GET
/erp/api/sensitive-word/query-page
敏感字管理接口
查询敏感词接口
OperationId: queryPage
调用方法
GET /erp/api/sensitive-word/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| type | query | 是 | int | 类型 1:白名单 0:黑名单 | 1 |
| txt | query | 否 | string | 文本 | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysSensitiveWord com.leadwaycloud.core.model.ROrg.springframework.data.domain.PageCom.leadwaycloud.manager.business.sensitive.word.entity.SysSensitiveWord
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysSensitiveWord | 否 | | |
GET
/erp/api/role/query/{id}
商户角色管理接口
查询角色(ID)接口
OperationId: query_10
调用方法
GET /erp/api/role/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResRole com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.role.entity.ResRole
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResRole | 否 | | |
GET
/erp/api/role/query-page
商户角色管理接口
查询角色(分页)接口
OperationId: pageQuery_6
调用方法
GET /erp/api/role/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| companyId | query | 是 | long | 公司ID | 1 |
| name | query | 否 | string | 名称 | "系统管理" |
| system | query | 否 | string | 是否是系统默认分组 | false |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResRole com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.role.entity.ResRole
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResRole | 否 | | |
GET
/erp/api/role/query-page/user/{id}
商户角色管理接口
查询角色用户信息(分页)接口
OperationId: pageQueryUser
调用方法
GET /erp/api/role/query-page/user/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResUser com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.user.entity.ResUser
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResUser | 否 | | |
GET
/erp/api/role/query-page/function/{id}
商户角色管理接口
查询角色功能信息(分页)接口
OperationId: pageQueryFunction
调用方法
GET /erp/api/role/query-page/function/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysFunction com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.function.entity.SysFunction
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysFunction | 否 | | |
GET
/erp/api/role/query-list/user/{id}
商户角色管理接口
查询角色用户信息(列表)接口
OperationId: queryListUser
调用方法
GET /erp/api/role/query-list/user/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResUser com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.user.entity.ResUser
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResUser[] | 否 | 返回数据 | |
GET
/erp/api/role/query-list/function/{id}
商户角色管理接口
查询角色功能信息(列表)接口
OperationId: queryListFunction
调用方法
GET /erp/api/role/query-list/function/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysFunction com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.function.entity.SysFunction
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysFunction[] | 否 | 返回数据 | |
GET
/erp/api/report/query/{id}
系统报表管理接口
查询系统报表(ID)接口
OperationId: query_11
调用方法
GET /erp/api/report/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 报表ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysReport com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.report.entity.SysReport
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysReport | 否 | | |
GET
/erp/api/report/query/view-config/{id}
系统报表管理接口
查询系统报表展示配置接口
OperationId: queryReportViewConfig
调用方法
GET /erp/api/report/query/view-config/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 报表ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysReportViewConfig com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.report.entity.SysReportViewConfig
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysReportViewConfig | 否 | | |
GET
/erp/api/report/query-page
系统报表管理接口
查询系统报表(分页)接口
OperationId: query_12
调用方法
GET /erp/api/report/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| modelId | query | 否 | long | 模块ID | 1 |
| name | query | 否 | string | 名称 | "xxx报表" |
| alias | query | 否 | string | 别名 | "xxx报表" |
| type | query | 否 | string | 类型 | "EXCEL" |
| merchantIndustry | query | 否 | string | 商户行业 | "COMPLEX" |
| companyType | query | 否 | string | 公司类型 | "STORE" |
| active | query | 否 | boolean | 是否可用 | true |
| useType | query | 否 | string | 用途类型 | "DASHBOARD" |
| merchantId | query | 否 | long | 商户ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysReport com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.report.entity.SysReport
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysReport | 否 | | |
GET
/erp/api/platform-version-manager/query-page
平台版本管理
查询平台版本(分页)接口
OperationId: pageQuery_7
调用方法
GET /erp/api/platform-version-manager/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| 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.manager.business.platform.version.entity.SysPlatformVersion
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysPlatformVersion | 否 | | |
GET
/erp/api/model/query/{id}
模块管理接口
查询模块(ID)接口
OperationId: query_14
调用方法
GET /erp/api/model/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysModel com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.model.entity.SysModel
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysModel | 否 | | |
GET
/erp/api/model/query-list
模块管理接口
查询模块(列表)接口
OperationId: queryList_1
调用方法
GET /erp/api/model/query-list
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| arg0 | query | 是 | QueryModelDTO | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysModel com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.model.entity.SysModel
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysModel[] | 否 | 返回数据 | |
GET
/erp/api/model/query-list/specific
模块管理接口
查询指定行业下某个公司类型包含的模块(列表)接口
OperationId: querySpecific
调用方法
GET /erp/api/model/query-list/specific
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantIndustry | query | 是 | string | 商户行业 | "COMPLEX" |
| companyType | query | 是 | string | 公司类型 | "MERCHANT" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysModel com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.model.entity.SysModel
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysModel[] | 否 | 返回数据 | |
GET
/erp/api/merchant/query/{id}
商户管理接口
查询商户(ID)接口
OperationId: query_15
调用方法
GET /erp/api/merchant/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResMerchant com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.merchant.entity.ResMerchant
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResMerchant | 否 | | |
GET
/erp/api/merchant/query/init-data/{id}
商户管理接口
查询商户初始化数据接口
OperationId: queryInitData
调用方法
GET /erp/api/merchant/query/init-data/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResMerchantInit com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.merchant.entity.ResMerchantInit
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResMerchantInit[] | 否 | 返回数据 | |
GET
/erp/api/merchant/query-page
商户管理接口
查询商户(分页)接口
OperationId: pageQuery_8
调用方法
GET /erp/api/merchant/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| code | query | 否 | string | 商户代号 | "lwc" |
| abbreviation | query | 否 | string | 简称 | "立威云" |
| fullName | query | 否 | string | 全称 | "成都立威云科技有限公司" |
| status | query | 否 | string | 是否可用 | "OPEN" |
| industry | query | 否 | string | 行业 | "COMPLEX" |
| email | query | 否 | string | 联系邮箱(用作初始化创建账号) | "sale@leadwaycloud.com" |
| phone | query | 否 | string | 联系电话 | |
| address | query | 否 | string | 联系地址 | |
| currencyId | query | 否 | long | 货币ID | 1 |
| expireDate | query | 否 | string | 过期日期 | "2029-11-30" |
| userCount | query | 否 | int | 用户数量 | 1 |
| posCount | query | 否 | int | 机台数量 | 1 |
| modelIdList | query | 否 | list | 模块ID | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResMerchant com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.merchant.entity.ResMerchant
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResMerchant | 否 | | |
GET
/erp/api/merchant/query-code/{code}
商户管理接口
查询商户(代号)接口
OperationId: queryByCode_1
调用方法
GET /erp/api/merchant/query-code/{code}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| code | path | 是 | string | 商户代号 | "lwc" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResMerchant com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.merchant.entity.ResMerchant
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResMerchant | 否 | | |
GET
/erp/api/merchant-init/query
商户初始化管理接口
查询系统初始化商户数据接口
OperationId: queryInitData_1
调用方法
GET /erp/api/merchant-init/query
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantIndustry | query | 是 | string | 商户行业 | "COMPLEX" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysInitMerchant com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.merchant.entity.SysInitMerchant
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysInitMerchant[] | 否 | 返回数据 | |
GET
/erp/api/imp-merchant-init-data/query/{merchantId}
导入商户初始数据接口
查询商户初始数据导入结果接口
OperationId: queryImpDataProcessResult
调用方法
GET /erp/api/imp-merchant-init-data/query/{merchantId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantId | path | 是 | integer(int64) | 商户ID | 908451251839992 |
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| dataType | query | 否 | string | 导入数据类型 | "USER" |
| impDate | query | 否 | string | 导入日期 | "2020-10-11" |
| process | query | 否 | boolean | 是否有进行过处理 | false |
| success | query | 否 | boolean | 是否处理成功 | false |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ImpMerchantInitData com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.merchant.entity.ImpMerchantInitData
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ImpMerchantInitData | 否 | | |
GET
/erp/api/imp-merchant-init-data/query/support-imp-data-type
导入商户初始数据接口
查询支持商户导入的初始数据类型接口
OperationId: querySupportImpDataType
调用方法
GET /erp/api/imp-merchant-init-data/query/support-imp-data-type
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SupportImpDataTypeVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.merchant.vo.SupportImpDataTypeVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SupportImpDataTypeVO[] | 否 | 返回数据 | |
GET
/erp/api/imp-merchant-init-data/query/all-support-imp-data/import-finish-status/{merchantId}
导入商户初始数据接口
查询商户所有可以导入的数据导入状态接口
OperationId: queryAllSupportImpDataImportFinishStatus
调用方法
GET /erp/api/imp-merchant-init-data/query/all-support-imp-data/import-finish-status/{merchantId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantId | path | 是 | integer(int64) | 商户ID | 908451251839992 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.util.MapJava.lang.StringJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
GET
/erp/api/im-template-msg/query/{id}
即时通讯消息模版管理接口
查询通讯消息模版(ID)接口
OperationId: query_17
调用方法
GET /erp/api/im-template-msg/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 报表ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: IMMsgTemplate com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.im.msg.template.entity.IMMsgTemplate
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMMsgTemplate | 否 | | |
GET
/erp/api/im-template-msg/query-page
即时通讯消息模版管理接口
查询通讯消息模版(分页)接口
OperationId: query_18
调用方法
GET /erp/api/im-template-msg/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| code | query | 否 | string | 编号 | |
| name | query | 否 | string | 名称 | "会议邀请" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: IMMsgTemplate com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.im.msg.template.entity.IMMsgTemplate
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMMsgTemplate | 否 | | |
GET
/erp/api/i18n/query/translation/{lang}/{industry}
国际化管理
查询国际化翻译字典接口
OperationId: queryTranslation
调用方法
GET /erp/api/i18n/query/translation/{lang}/{industry}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| lang | path | 是 | integer(int64) | 语言ID | 1 |
| industry | path | 是 | string | 商户类型 | "COMPLEX_RETAIL" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: TranslationDTO com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.i18n.dto.TranslationDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | TranslationDTO | 否 | | |
GET
/erp/api/function/query/{id}
功能管理接口
查询功能(ID)接口
OperationId: query_19
调用方法
GET /erp/api/function/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysFunctionVO com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.function.vo.SysFunctionVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysFunctionVO | 否 | | |
GET
/erp/api/function/query-page
功能管理接口
查询功能(分页)接口
OperationId: pageQuery_10
调用方法
GET /erp/api/function/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| name | query | 否 | string | 名称 | |
| webMenuLevel | query | 否 | int | 页面菜单级别 | 1 |
| webType | query | 否 | string | 页面类型 | |
| webRouter | query | 否 | string | 页面路由 | |
| index | query | 否 | int | 页面渲染顺序 | 1 |
| buttonType | query | 否 | string | 按钮类型 | |
| modelId | query | 否 | long | 模块ID | 1 |
| menuId | query | 否 | long | 菜单ID | 1 |
| parentFunctionId | query | 否 | long | 上级功能ID | 1 |
| apiId | query | 否 | long | API接口ID | 1 |
| appId | query | 否 | long | sys_app.id | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysFunction com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.function.entity.SysFunction
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysFunction | 否 | | |
GET
/erp/api/function/query-list
功能管理接口
查询功能(列表)接口
OperationId: query_20
调用方法
GET /erp/api/function/query-list
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| name | query | 否 | string | 名称 | |
| webMenuLevel | query | 否 | int | 页面菜单级别 | 1 |
| webType | query | 否 | string | 页面类型 | |
| webRouter | query | 否 | string | 页面路由 | |
| index | query | 否 | int | 页面渲染顺序 | 1 |
| buttonType | query | 否 | string | 按钮类型 | |
| modelId | query | 否 | long | 模块ID | 1 |
| menuId | query | 否 | long | 菜单ID | 1 |
| parentFunctionId | query | 否 | long | 上级功能ID | 1 |
| apiId | query | 否 | long | API接口ID | 1 |
| appId | query | 否 | long | sys_app.id | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysFunction com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.function.entity.SysFunction
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysFunction[] | 否 | 返回数据 | |
GET
/erp/api/function/query-list/specific
功能管理接口
查询特定功能(列表)接口
OperationId: query_21
调用方法
GET /erp/api/function/query-list/specific
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantIndustry | query | 是 | string | 商户行业 | "COMPLEX" |
| companyType | query | 是 | string | 公司类型 | "MERCHANT" |
| modelId | query | 否 | integer(int64) | 模块ID | 593975631190135 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysFunction com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.function.entity.SysFunction
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysFunction[] | 否 | 返回数据 | |
GET
/erp/api/express/query/{id}
快递公司管理接口
查询快递公司(ID)接口
OperationId: query_22
调用方法
GET /erp/api/express/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysExpress com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.express.entity.SysExpress
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysExpress | 否 | | |
GET
/erp/api/express/query/code/{code}
快递公司管理接口
查询快递公司(编号)接口
OperationId: query_23
调用方法
GET /erp/api/express/query/code/{code}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| code | path | 是 | string | 编号 | "ems" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysExpress com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.express.entity.SysExpress
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysExpress | 否 | | |
GET
/erp/api/express/query-page
快递公司管理接口
查询快递公司(分页)接口
OperationId: queryPage_1
调用方法
GET /erp/api/express/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysExpress com.leadwaycloud.core.model.ROrg.springframework.data.domain.PageCom.leadwaycloud.manager.business.express.entity.SysExpress
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysExpress | 否 | | |
GET
/erp/api/device-command/query
系统设备指令管理接口
查询系统设备指令(设备信息)接口
OperationId: pageQuery_11
调用方法
GET /erp/api/device-command/query
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| brand | query | 是 | string | 品牌 | "Epson" |
| model | query | 是 | string | 信号 | "TM-T70" |
| type | query | 是 | string | 设备类型 | "PRINTER" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysDeviceCommand com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.device.command.entity.SysDeviceCommand
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysDeviceCommand | 否 | | |
GET
/erp/api/device-command/query/{id}
系统设备指令管理接口
查询系统设备指令(ID)接口
OperationId: query_24
调用方法
GET /erp/api/device-command/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysDeviceCommand com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.device.command.entity.SysDeviceCommand
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysDeviceCommand | 否 | | |
GET
/erp/api/device-command/query-page
系统设备指令管理接口
查询系统设备指令(分页)接口
OperationId: pageQuery_12
调用方法
GET /erp/api/device-command/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysDeviceCommand com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.device.command.entity.SysDeviceCommand
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysDeviceCommand | 否 | | |
GET
/erp/api/currency/query/{id}
货币管理接口
查询货币(ID)接口
OperationId: query_25
调用方法
GET /erp/api/currency/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysCurrency com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.currency.entity.SysCurrency
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysCurrency | 否 | | |
GET
/erp/api/currency/query-rate
货币管理接口
查询货币汇率接口
OperationId: queryRate
调用方法
GET /erp/api/currency/query-rate
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| 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.manager.business.currency.entity.SysCurrencyRate
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysCurrencyRate | 否 | | |
GET
/erp/api/currency/query-page
货币管理接口
查询货币(分页)接口
OperationId: pageQuery_13
调用方法
GET /erp/api/currency/query-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.manager.business.currency.entity.SysCurrency
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysCurrency | 否 | | |
GET
/erp/api/currency/query-page-rate
货币管理接口
查询货币汇率(分页)接口
OperationId: queryRate_1
调用方法
GET /erp/api/currency/query-page-rate
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| localDate | query | 是 | string(date) | 查询日 | "2020-11-20" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysCurrencyRate com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.currency.entity.SysCurrencyRate
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysCurrencyRate | 否 | | |
GET
/erp/api/currency/query-code/{code}
货币管理接口
查询货币(代号)接口
OperationId: queryByCode_3
调用方法
GET /erp/api/currency/query-code/{code}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| code | path | 是 | string | 代号 | "CNY" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysCurrency com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.currency.entity.SysCurrency
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysCurrency | 否 | | |
GET
/erp/api/company/query/{id}
商户公司管理接口
查询公司(ID)接口
OperationId: query_26
调用方法
GET /erp/api/company/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResCompany com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.company.entity.ResCompany
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResCompany | 否 | | |
GET
/erp/api/company/query/init-data/{id}
商户公司管理接口
查询公司初始化数据接口
OperationId: queryInitData_2
调用方法
GET /erp/api/company/query/init-data/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResCompanyInit com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.company.entity.ResCompanyInit
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResCompanyInit[] | 否 | 返回数据 | |
GET
/erp/api/company/query-page
商户公司管理接口
查询公司(分页)接口
OperationId: pageQuery_14
调用方法
GET /erp/api/company/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| code | query | 否 | string | 公司编号(仅允许字母和数字) | "CD01" |
| otherCode | query | 否 | string | 其他编号 | "AAAA-01" |
| type | query | 否 | string | 类型 | "STORE" |
| status | query | 否 | string | 状态 | "IN_OPERATION" |
| idChain | query | 否 | string | 公司ID完整架构(上下级公司id用-连接) | "123-456" |
| merchantId | query | 否 | long | 商户ID | 1 |
| parentCompanyId | query | 否 | long | 上级公司ID | 1 |
| name | query | 否 | string | 名称 | |
| initConfig | query | 否 | boolean | 公司配置是否初始化 | false |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResCompany com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.company.entity.ResCompany
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResCompany | 否 | | |
GET
/erp/api/company/query-other-code/{merchantId}/{otherCode}
商户公司管理接口
查询公司(其他编号)接口
OperationId: queryByOther
调用方法
GET /erp/api/company/query-other-code/{merchantId}/{otherCode}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantId | path | 是 | integer(int64) | 公司ID | 123 |
| otherCode | path | 是 | string | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResCompany com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.company.entity.ResCompany
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResCompany | 否 | | |
GET
/erp/api/company/query-list
商户公司管理接口
查询公司(分页)接口
OperationId: query_27
调用方法
GET /erp/api/company/query-list
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| code | query | 否 | string | 公司编号(仅允许字母和数字) | "CD01" |
| otherCode | query | 否 | string | 其他编号 | "AAAA-01" |
| type | query | 否 | string | 类型 | "STORE" |
| status | query | 否 | string | 状态 | "IN_OPERATION" |
| idChain | query | 否 | string | 公司ID完整架构(上下级公司id用-连接) | "123-456" |
| merchantId | query | 否 | long | 商户ID | 1 |
| parentCompanyId | query | 否 | long | 上级公司ID | 1 |
| name | query | 否 | string | 名称 | |
| initConfig | query | 否 | boolean | 公司配置是否初始化 | false |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResCompany com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.company.entity.ResCompany
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResCompany[] | 否 | 返回数据 | |
GET
/erp/api/company/query-code/{merchantId}/{code}
商户公司管理接口
查询公司(编号)接口
OperationId: queryByCode_4
调用方法
GET /erp/api/company/query-code/{merchantId}/{code}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantId | path | 是 | integer(int64) | 公司ID | 123 |
| code | path | 是 | string | 公司编号 | "lwc" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResCompany com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.company.entity.ResCompany
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResCompany | 否 | | |
GET
/erp/api/company-init/query/init-data
公司初始化管理接口
查询系统初始化公司数据接口
OperationId: queryInitData_3
调用方法
GET /erp/api/company-init/query/init-data
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantIndustry | query | 是 | string | 公司行业 | "COMPLEX" |
| companyType | query | 是 | string | 公司类型 | "STORE" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysInitCompany com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.company.entity.SysInitCompany
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysInitCompany[] | 否 | 返回数据 | |
GET
/erp/api/application/query/{id}
系统应用管理接口
查询应用(ID)接口
OperationId: query_28
调用方法
GET /erp/api/application/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysApplication com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.application.entity.SysApplication
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysApplication | 否 | | |
GET
/erp/api/application/query-page
系统应用管理接口
查询应用(分页)接口
OperationId: pageQuery_15
调用方法
GET /erp/api/application/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| merchantIndustry | query | 否 | string | 商户行业 | "COMPLEX" |
| companyType | query | 否 | string | 公司类型 | "STORE" |
| name | query | 否 | string | 名称 | "收银服务" |
| active | query | 否 | boolean | 是否可用 | true |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysApplication com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.application.entity.SysApplication
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysApplication | 否 | | |
GET
/erp/api/application/query-page/api/{id}
系统应用管理接口
查询应用关联API信息(分页)接口
OperationId: pageQueryRelevanceApi
调用方法
GET /erp/api/application/query-page/api/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysApi com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.api.entity.SysApi
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysApi | 否 | | |
GET
/erp/api/application/query-list/api/{id}
系统应用管理接口
查询应用关联API(List)接口
OperationId: queryAllRelevanceApi
调用方法
GET /erp/api/application/query-list/api/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 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
/erp/api/application/export/api/{id}
系统应用管理接口
导出应用关联API信息接口
OperationId: export
调用方法
GET /erp/api/application/export/api/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: application/octet-stream 类型: string(byte)
无
GET
/erp/api/app/query
APP管理接口
查询当前支持的APP接口
OperationId: queryApp
调用方法
GET /erp/api/app/query
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| arg0 | query | 是 | QueryAppDTO | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysApp com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.app.entity.SysApp
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysApp[] | 否 | 返回数据 | |
GET
/erp/api/app/query/version/{appId}
APP管理接口
查询APP版本信息接口
OperationId: queryAppPackage
调用方法
GET /erp/api/app/query/version/{appId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| appId | path | 是 | integer(int64) | APP ID | 1 |
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| platform | query | 否 | string | 平台 | "WINDOWS" |
| framework | query | 否 | string | 架构 | "x86" |
| version | query | 否 | string | 版本 | "1.0.0.1" |
| buildVersion | query | 否 | string | 构建版本 | 20241217001 |
| cold | query | 否 | string | 是否必须冷更新 | true |
| active | query | 否 | boolean | 是否已发布 | true |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysAppPackage com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.app.entity.SysAppPackage
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysAppPackage | 否 | | |
GET
/erp/api/app/query/sandbox-version
APP管理接口
获取APP沙盒版本接口
OperationId: queryAppSandboxVersion
调用方法
GET /erp/api/app/query/sandbox-version
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| appCode | query | 是 | string | APP代号 | "xxx" |
| platform | query | 是 | string | 平台 | "windows" |
| framework | query | 否 | string | 架构 | "x86" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysAppPackage com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.app.entity.SysAppPackage
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysAppPackage | 否 | | |
GET
/erp/api/app/query/last-version
APP管理接口
获取APP最新版本接口
OperationId: queryAppLastVersion
调用方法
GET /erp/api/app/query/last-version
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| appCode | query | 是 | string | APP代号 | "xxx" |
| platform | query | 是 | string | 平台 | "windows" |
| framework | query | 否 | string | 架构 | "x86" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysAppPackage com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.app.entity.SysAppPackage
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysAppPackage | 否 | | |
GET
/erp/api/app/query/all-version
APP管理接口
获取APP全部版本接口
OperationId: queryAppAllVersion
调用方法
GET /erp/api/app/query/all-version
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| appCode | query | 是 | string | APP代号 | "xxx" |
| platform | query | 是 | string | 平台 | "windows" |
| framework | query | 否 | string | 架构 | "x86" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysAppPackage com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.app.entity.SysAppPackage
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysAppPackage[] | 否 | 返回数据 | |
GET
/erp/api/app/download/app-version-file/{shortCode}
APP管理接口
下载APP版本文件接口
OperationId: downloadAppVersionFile
调用方法
GET /erp/api/app/download/app-version-file/{shortCode}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| shortCode | path | 是 | string | 文件短号 | "xxx" |
请求体
无
响应
GET
/erp/api/api/query/{id}
系统API管理接口
查询系统API(ID)接口
OperationId: query_29
调用方法
GET /erp/api/api/query/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysApi com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.api.entity.SysApi
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysApi | 否 | | |
GET
/erp/api/api/query-service-list
系统API管理接口
查询系统服务(列表)接口
OperationId: queryServiceList
调用方法
GET /erp/api/api/query-service-list
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: ServiceDTO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.api.dto.ServiceDTO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ServiceDTO[] | 否 | 返回数据 | |
GET
/erp/api/api/query-page
系统API管理接口
查询系统API(分页)接口
OperationId: pageQuery_16
调用方法
GET /erp/api/api/query-page
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| open | query | 否 | boolean | 是否是公共的 | false |
| serviceCode | query | 否 | string | 服务编号 | "lwc-cloud-erp-manager" |
| name | query | 否 | string | 名称 | "停用账号" |
| path | query | 否 | string | 接口路径 | "/lwc-cloud-erp-manager/sys/api/user/update-info" |
| method | query | 否 | string | 请求方式 | "PUT" |
| description | query | 否 | string | 接口描述 | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysApi com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.api.entity.SysApi
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysApi | 否 | | |
GET
/erp/api/api/query-list
系统API管理接口
查询系统API(列表)接口
OperationId: queryList_3
调用方法
GET /erp/api/api/query-list
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| arg0 | query | 是 | QueryApiDTO | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysApi com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.api.entity.SysApi
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysApi[] | 否 | 返回数据 | |
GET
/erp/api/address/query/administrative-divisions
地址管理接口
获取五级联动数据接口
OperationId: getAdministrativeDivisions
调用方法
GET /erp/api/address/query/administrative-divisions
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| type | query | 是 | string | 类型 | "COUNTRY" |
| parentId | query | 否 | long | 上一级ID(国家/地区类型时,可不提供) | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: AddressVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.address.vo.AddressVO
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | AddressVO[] | 否 | 返回数据 | |
GET
/erp/api/accounting/query/type/{accountingTypeId}
会计科目管理接口
查询会计科目类别(ID)接口
OperationId: queryType
调用方法
GET /erp/api/accounting/query/type/{accountingTypeId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| accountingTypeId | path | 是 | integer(int64) | 会计科目类别ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysAccountingType com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.accounting.entity.SysAccountingType
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysAccountingType | 否 | | |
GET
/erp/api/accounting/query/type/code/{typeCode}
会计科目管理接口
查询会计科目类别(代号)接口
OperationId: queryType_1
调用方法
GET /erp/api/accounting/query/type/code/{typeCode}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| typeCode | path | 是 | string | 会计科目类别代号 | 1000 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysAccountingType com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.accounting.entity.SysAccountingType
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysAccountingType | 否 | | |
GET
/erp/api/accounting/query/title/{accountingTitleId}
会计科目管理接口
查询会计科目(ID)接口
OperationId: queryTitle
调用方法
GET /erp/api/accounting/query/title/{accountingTitleId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| accountingTitleId | path | 是 | integer(int64) | 会计科目ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysAccountingTitle com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.accounting.entity.SysAccountingTitle
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysAccountingTitle | 否 | | |
GET
/erp/api/accounting/query/title/code/{titleCode}
会计科目管理接口
查询会计科目(代号)接口
OperationId: queryTitle_1
调用方法
GET /erp/api/accounting/query/title/code/{titleCode}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| titleCode | path | 是 | string | 会计科目代号 | 1001 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysAccountingTitle com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.accounting.entity.SysAccountingTitle
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysAccountingTitle | 否 | | |
GET
/erp/api/accounting/query-page/title
会计科目管理接口
查询会计科目类别(分页)接口
OperationId: queryTitle_2
调用方法
GET /erp/api/accounting/query-page/title
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| accountingTypeId | query | 否 | long | 科目类型ID | 1 |
| code | query | 否 | string | 编号 | 1001 |
| name | query | 否 | string | 名称 | "库存现金" |
| enName | query | 否 | string | 英文名称 | "Cash" |
| scope | query | 否 | string | 会计科目使用范围 | |
| allowBillUpdateAmount | query | 否 | boolean | 是否允许在收/付款单中修改金额 | true |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysAccountingTitle com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.accounting.entity.SysAccountingTitle
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysAccountingTitle | 否 | | |
GET
/erp/api/accounting/query-list/type
会计科目管理接口
查询会计科目类别(List)接口
OperationId: queryType_2
调用方法
GET /erp/api/accounting/query-list/type
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| code | query | 否 | string | 编号(纯数字) | 1000 |
| name | query | 否 | string | 名称 | "资产类" |
| enName | query | 否 | string | 英文名称 | "Assets" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysAccountingType com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.accounting.entity.SysAccountingType
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysAccountingType[] | 否 | 返回数据 | |
GET
/api/sys/property/page
系统公用属性
查询系统属性列表(分页)
OperationId: page
调用方法
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 | 否 | long | 商户ID | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysProperty com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.property.entity.SysProperty
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysProperty | 否 | | |
GET
/api/sys/property/list
系统公用属性
查询系统属性列表
OperationId: list
调用方法
GET /api/sys/property/list
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| name | query | 否 | string | 名称 | |
| group | query | 否 | string | 分组 | |
| active | query | 否 | boolean | 是否可用 | |
| merchantId | query | 否 | long | 商户ID | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysProperty com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.property.entity.SysProperty
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysProperty[] | 否 | 返回数据 | |
GET
/api/sys/property/list/{group}
系统公用属性
查询系统属性列表
OperationId: list_1
根据group精确搜索
调用方法
GET /api/sys/property/list/{group}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| group | path | 是 | string | | |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysProperty com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.property.entity.SysProperty
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysProperty[] | 否 | 返回数据 | |
GET
/api/sys/property/get
系统公用属性
查询系统属性
OperationId: query_30
调用方法
GET /api/sys/property/get
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | query | 是 | integer(int64) | 属性ID | 0 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysProperty com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.property.entity.SysProperty
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysProperty | 否 | | |
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 | 否 | 返回数据 | |
DELETE
/erp/api/user/clear/redis-user-permissions/{id}
商户用户管理接口
清空Redis用户缓存数据接口
OperationId: clearRedisUserPermissions
调用方法
DELETE /erp/api/user/clear/redis-user-permissions/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
DELETE
/erp/api/sys-import-template/remove/{id}
系统导入模版管理接口
删除系统导入模版接口
OperationId: remove_1
物理删除
调用方法
DELETE /erp/api/sys-import-template/remove/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 系统导入模版ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
DELETE
/erp/api/sensitive-word/delete/deny
敏感字管理接口
删除敏感词黑名单接口
OperationId: deleteDeny
调用方法
DELETE /erp/api/sensitive-word/delete/deny
参数
无
请求体
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 | 否 | 返回数据 | |
DELETE
/erp/api/sensitive-word/delete/allow
敏感字管理接口
删除敏感词白名单接口
OperationId: deleteAllow
调用方法
DELETE /erp/api/sensitive-word/delete/allow
参数
无
请求体
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 | 否 | 返回数据 | |
DELETE
/erp/api/role/patch-delete/user/{id}
商户角色管理接口
角色批量删除用户接口
OperationId: patchDeleteUser
调用方法
DELETE /erp/api/role/patch-delete/user/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | integer(int64)[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResRole com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.role.entity.ResRole
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResRole | 否 | | |
DELETE
/erp/api/role/patch-delete/function/{id}
商户角色管理接口
角色批量删除功能接口
OperationId: patchDeleteFunction
调用方法
DELETE /erp/api/role/patch-delete/function/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | integer(int64)[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: ResRole com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.role.entity.ResRole
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ResRole | 否 | | |
DELETE
/erp/api/report/remove/{id}
系统报表管理接口
删除系统报表接口
OperationId: remove_2
物理删除
调用方法
DELETE /erp/api/report/remove/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 报表ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
DELETE
/erp/api/report/remove/view-config/{reportViewConfigId}
系统报表管理接口
删除系统报表展示配置接口
OperationId: removeReportViewConfig
物理删除
调用方法
DELETE /erp/api/report/remove/view-config/{reportViewConfigId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| reportViewConfigId | path | 是 | integer(int64) | 报表ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
DELETE
/erp/api/merchant-init/delete/{id}
商户初始化管理接口
删除系统初始化商户数据接口
OperationId: deleteInitData
物理删除
调用方法
DELETE /erp/api/merchant-init/delete/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 系统初始化商户数据ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
DELETE
/erp/api/function/delete/{id}
功能管理接口
删除功能接口
OperationId: delete_1
物理删除
调用方法
DELETE /erp/api/function/delete/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
DELETE
/erp/api/function/delete/template/{merchantIndustry}/{companyType}/{functionId}
功能管理接口
删除指定功能模版(指定行业中公司类型所属功能)接口
OperationId: deleteTemplateFunction
物理删除
调用方法
DELETE /erp/api/function/delete/template/{merchantIndustry}/{companyType}/{functionId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantIndustry | path | 是 | string | 商户行业 | "COMPLEX" |
| companyType | path | 是 | string | 公司类型 | "MERCHANT" |
| functionId | path | 是 | integer(int64) | 功能ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
DELETE
/erp/api/function/delete-batch/template/{merchantIndustry}/{companyType}
功能管理接口
-
OperationId: batchDeleteTemplateFunction
调用方法
DELETE /erp/api/function/delete-batch/template/{merchantIndustry}/{companyType}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| merchantIndustry | path | 是 | string | | |
| companyType | path | 是 | string | | |
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | integer(int64)[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
DELETE
/erp/api/company-init/delete/init-data/{id}
公司初始化管理接口
删除系统初始化公司数据接口
OperationId: deleteInitData_1
调用方法
DELETE /erp/api/company-init/delete/init-data/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | 系统初始化公司数据ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
DELETE
/erp/api/application/patch-delete/api/{id}
系统应用管理接口
应用批量删除关联API接口
OperationId: batchDeleteRelevanceApi
调用方法
DELETE /erp/api/application/patch-delete/api/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
Content-Type: application/json 必填: 是 类型: integer(int64)[]
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| (array) | integer(int64)[] | | | |
响应
状态码: 200 说明: OK Content-Type: */* 类型: SysApplication com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.application.entity.SysApplication
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysApplication | 否 | | |
DELETE
/erp/api/application/delete/{id}
系统应用管理接口
删除应用接口
OperationId: delete_2
物理删除
调用方法
DELETE /erp/api/application/delete/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
DELETE
/erp/api/app/delete/{appVersionId}
APP管理接口
删除APP版本接口
OperationId: delete_3
调用方法
DELETE /erp/api/app/delete/{appVersionId}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| appVersionId | path | 是 | integer(int64) | APP 版本ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
DELETE
/erp/api/api/delete/{id}
系统API管理接口
删除系统API接口
OperationId: delete_4
调用方法
DELETE /erp/api/api/delete/{id}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| id | path | 是 | integer(int64) | ID | 1 |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
DELETE
/erp/api/api/delete/server-code/{serverCode}
系统API管理接口
删除系统API接口
OperationId: delete_5
调用方法
DELETE /erp/api/api/delete/server-code/{serverCode}
参数
| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
|---|
| serverCode | path | 是 | string | 服务编号 | "lwc-cloud-erp-system" |
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: Boolean com.leadwaycloud.core.model.RJava.lang.Boolean
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 | |
GET
/error
main-site-error-handler
-
OperationId: handleError
调用方法
GET /error
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
POST
/error
main-site-error-handler
-
OperationId: handleError_1
调用方法
POST /error
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
PUT
/error
main-site-error-handler
-
OperationId: handleError_2
调用方法
PUT /error
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
DELETE
/error
main-site-error-handler
-
OperationId: handleError_3
调用方法
DELETE /error
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
PATCH
/error
main-site-error-handler
-
OperationId: handleError_4
调用方法
PATCH /error
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
OPTIONS
/error
main-site-error-handler
-
OperationId: handleError_6
调用方法
OPTIONS /error
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
HEAD
/error
main-site-error-handler
-
OperationId: handleError_5
调用方法
HEAD /error
参数
无
请求体
无
响应
状态码: 200 说明: OK Content-Type: */* 类型: R com.leadwaycloud.core.model.R
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 | |
模型定义
PageableObject
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| paged | boolean | 否 | | |
| pageNumber | integer(int32) | 否 | | |
| offset | integer(int64) | 否 | | |
| sort | SortObject | 否 | | |
| pageSize | integer(int32) | 否 | | |
| unpaged | boolean | 否 | | |
SortObject
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| sorted | boolean | 否 | | |
| empty | boolean | 否 | | |
| unsorted | boolean | 否 | | |
com.leadwaycloud.core.model.ROrg.springframework.data.domain.PageCom.leadwaycloud.manager.business.sensitive.word.entity.SysSensitiveWord
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysSensitiveWord | 否 | | |
org.springframework.data.domain.PageCom.leadwaycloud.manager.business.sensitive.word.entity.SysSensitiveWord
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| totalElements | integer(int64) | 否 | | |
| totalPages | integer(int32) | 否 | | |
| pageable | PageableObject | 否 | | |
| size | integer(int32) | 否 | | |
| content | SysSensitiveWord[] | 否 | | |
| number | integer(int32) | 否 | | |
| sort | SortObject | 否 | | |
| numberOfElements | integer(int32) | 否 | | |
| first | boolean | 否 | | |
| last | boolean | 否 | | |
| empty | boolean | 否 | | |
com.leadwaycloud.core.model.ROrg.springframework.data.domain.PageCom.leadwaycloud.manager.business.express.entity.SysExpress
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SysExpress | 否 | | |
org.springframework.data.domain.PageCom.leadwaycloud.manager.business.express.entity.SysExpress
返回数据
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| totalElements | integer(int64) | 否 | | |
| totalPages | integer(int32) | 否 | | |
| pageable | PageableObject | 否 | | |
| size | integer(int32) | 否 | | |
| content | SysExpress[] | 否 | | |
| number | integer(int32) | 否 | | |
| sort | SortObject | 否 | | |
| numberOfElements | integer(int32) | 否 | | |
| first | boolean | 否 | | |
| last | boolean | 否 | | |
| empty | boolean | 否 | | |