# lwc-cloud-erp-manager API 接口文档

- 文档标题：product-manager
- 版本：2.0.5
- 描述：LWC Cloud API接口文档
- 数据来源：https://api.leadwaycloud.com/lwc-cloud-erp-manager/v3/api-docs
- 生成时间：2026-08-03T22:00:04.752Z
- 接口数量：235
- 分组数量：37
- 模型数量：255

## 服务地址

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

## 接口目录

### 用户管理

- [PUT /sys/api/user/update-password/{id} - 修改密码接口](#put-sys-api-user-update-password-id-updatepassword)
- [PUT /sys/api/user/update-info/{id} - 修改用户信息接口](#put-sys-api-user-update-info-id-updateinfo)
- [PUT /sys/api/user/forgot-password - 忘记密码接口](#put-sys-api-user-forgot-password-forgotpassword)
- [PUT /sys/api/user/activation - 账号激活接口](#put-sys-api-user-activation-updatepassword-1)
- [POST /sys/api/user/registration - 账号注册接口](#post-sys-api-user-registration-registration)
- [GET /sys/api/user/query/{id} - 查询用户(ID)接口](#get-sys-api-user-query-id-query)
- [GET /sys/api/user/query-page - 查询用户(分页)接口](#get-sys-api-user-query-page-query-1)
- [GET /sys/api/user/query-account/{account} - 查询用户(账号)接口](#get-sys-api-user-query-account-account-query-2)

### 版本号管理(作废)

- [PUT /erp/api/version-manager/update/{id} - 编辑版本接口](#put-erp-api-version-manager-update-id-update)
- [POST /erp/api/version-manager/add - 添加版本接口](#post-erp-api-version-manager-add-add)
- [GET /erp/api/version-manager/query-page - 查询版本(分页)接口](#get-erp-api-version-manager-query-page-pagequery)
- [GET /erp/api/version-manager/query-list - 查询版本(列表)接口](#get-erp-api-version-manager-query-list-query-3)

### 商户用户管理接口

- [PUT /erp/api/user/update-readVersionInfo ](#put-erp-api-user-update-readversioninfo-updateuserreadversioninfo)
- [GET /erp/api/user/query/{id} - 查询用户(ID)接口](#get-erp-api-user-query-id-query-4)
- [GET /erp/api/user/query-page - 查询用户(分页)接口](#get-erp-api-user-query-page-pagequery-1)
- [DELETE /erp/api/user/clear/redis-user-permissions/{id} - 清空Redis用户缓存数据接口](#delete-erp-api-user-clear-redis-user-permissions-id-clearredisuserpermissions)

### 计量单位管理接口

- [PUT /erp/api/uom/update/{id} - 修改计量单位接口](#put-erp-api-uom-update-id-update-1)
- [POST /erp/api/uom/upload - 导入计量单位](#post-erp-api-uom-upload-uploadmultipartfile)
- [POST /erp/api/uom/add - 添加计量单位接口](#post-erp-api-uom-add-add-1)
- [GET /erp/api/uom/query/{id} - 查询计量单位(ID)接口](#get-erp-api-uom-query-id-query-5)
- [GET /erp/api/uom/query-page - 查询计量单位(分页)接口](#get-erp-api-uom-query-page-pagequery-2)
- [GET /erp/api/uom/query-code/{code} - 查询计量单位(编号)接口](#get-erp-api-uom-query-code-code-querybycode)

### 系统打印模版管理接口

- [PUT /erp/api/sys-printer-template/update/{id} - 修改系统打印模版接口](#put-erp-api-sys-printer-template-update-id-update-2)
- [POST /erp/api/sys-printer-template/add/report - 添加系统报表打印模版接口](#post-erp-api-sys-printer-template-add-report-add-2)
- [POST /erp/api/sys-printer-template/add/receipt - 添加系统单据打印模版接口](#post-erp-api-sys-printer-template-add-receipt-add-3)
- [POST /erp/api/sys-printer-template/add/label - 添加系统标签打印模版接口](#post-erp-api-sys-printer-template-add-label-add-4)
- [GET /erp/api/sys-printer-template/query/{id} - 查询系统打印模版(ID)接口](#get-erp-api-sys-printer-template-query-id-query-6)
- [GET /erp/api/sys-printer-template/query/target - 查询目标对象数据接口](#get-erp-api-sys-printer-template-query-target-querytarget)
- [GET /erp/api/sys-printer-template/query-page - 查询系统打印模版(分页)接口](#get-erp-api-sys-printer-template-query-page-pagequery-3)

### 系统操作文档管理接口

- [PUT /erp/api/sys-operational-doc/update/custom-menu/doc/{docId} - 修改自定义菜单操作文档接口](#put-erp-api-sys-operational-doc-update-custom-menu-doc-docid-updatecustommenuope)
- [POST /erp/api/sys-operational-doc/init/sys-menu/doc - 初始化系统菜单操作文档接口](#post-erp-api-sys-operational-doc-init-sys-menu-doc-initsysmenuoperationaldoc)
- [POST /erp/api/sys-operational-doc/add/menu-operational-doc-file/{docId}/{langId} - 上传系统操作文档文件接口](#post-erp-api-sys-operational-doc-add-menu-operational-doc-file-docid-langid-addm)
- [POST /erp/api/sys-operational-doc/add/custom-menu/doc - 添加自定义菜单操作文档接口](#post-erp-api-sys-operational-doc-add-custom-menu-doc-addcustommenuoperationaldoc)
- [GET /erp/api/sys-operational-doc/query/{id} - 查询系统操作文档(ID)接口](#get-erp-api-sys-operational-doc-query-id-query-7)
- [GET /erp/api/sys-operational-doc/query-page - 查询系统操作文档(分页)接口](#get-erp-api-sys-operational-doc-query-page-pagequery-4)
- [DELETE /erp/api/sys-operational-doc/remove/menu-operational-doc-file/{dockerDetailId} - 删除系统操作文档文件接口](#delete-erp-api-sys-operational-doc-remove-menu-operational-doc-file-dockerdetail)
- [DELETE /erp/api/sys-operational-doc/remove/custom-menu/doc/{docId} - 删除自定义菜单操作文档接口](#delete-erp-api-sys-operational-doc-remove-custom-menu-doc-docid-removecustommenu)

### 系统参数管理接口

- [PUT /erp/api/setting/delete/{id} - 删除系统参数接口](#put-erp-api-setting-delete-id-delete)
- [POST /erp/api/setting/add - 添加系统参数接口](#post-erp-api-setting-add-add-5)
- [GET /erp/api/setting/query/{id} - 查询系统参数(ID)接口](#get-erp-api-setting-query-id-query-9)
- [GET /erp/api/setting/query-page - 查询系统参数(分页)接口](#get-erp-api-setting-query-page-pagequery-5)

### 系统报表管理接口

- [PUT /erp/api/report/update/{id} - 修改系统报表接口](#put-erp-api-report-update-id-update-3)
- [PUT /erp/api/report/update/view-config/{reportViewConfigId} - 修改系统报表展示配置接口](#put-erp-api-report-update-view-config-reportviewconfigid-updatereportviewconfig)
- [POST /erp/api/report/add - 添加系统报表接口](#post-erp-api-report-add-add-6)
- [POST /erp/api/report/add/view-config/{id} - 添加系统报表展示配置接口](#post-erp-api-report-add-view-config-id-addreportviewconfig)
- [GET /erp/api/report/query/{id} - 查询系统报表(ID)接口](#get-erp-api-report-query-id-query-11)
- [GET /erp/api/report/query/view-config/{id} - 查询系统报表展示配置接口](#get-erp-api-report-query-view-config-id-queryreportviewconfig)
- [GET /erp/api/report/query-page - 查询系统报表(分页)接口](#get-erp-api-report-query-page-query-12)
- [DELETE /erp/api/report/remove/{id} - 删除系统报表接口](#delete-erp-api-report-remove-id-remove-2)
- [DELETE /erp/api/report/remove/view-config/{reportViewConfigId} - 删除系统报表展示配置接口](#delete-erp-api-report-remove-view-config-reportviewconfigid-removereportviewconf)

### 平台版本管理

- [PUT /erp/api/platform-version-manager/update/{id} - 编辑平台版本接口](#put-erp-api-platform-version-manager-update-id-update-4)
- [POST /erp/api/platform-version-manager/confirm-platform-version/{userId} - 确认平台版本信息](#post-erp-api-platform-version-manager-confirm-platform-version-userid-confirmpla)
- [POST /erp/api/platform-version-manager/add - 添加平台版本接口](#post-erp-api-platform-version-manager-add-addplatformversion)
- [GET /erp/api/platform-version-manager/query-user-un-confirm-platform-version/{userId}/{businessCompanyId} - 查询用户未确认的平台版本信息](#get-erp-api-platform-version-manager-query-user-un-confirm-platform-version-user)
- [GET /erp/api/platform-version-manager/query-page - 查询平台版本(分页)接口](#get-erp-api-platform-version-manager-query-page-pagequery-7)
- [GET /erp/api/platform-version-manager/query-model-version - 查询平台版本(分页)接口](#get-erp-api-platform-version-manager-query-model-version-querymodelversion)
- [GET /erp/api/platform-version-manager/query-list - 查询平台版本(列表)接口](#get-erp-api-platform-version-manager-query-list-query-13)
- [GET /erp/api/platform-version-manager/query-list-subversion/{id} - 查询平台版本下后端服务版本信息](#get-erp-api-platform-version-manager-query-list-subversion-id-queryplatformversi)
- [GET /erp/api/platform-version-manager/query-fresh-version - 查询最新平台版本信息接口](#get-erp-api-platform-version-manager-query-fresh-version-queryfreshplatformversi)

### 模块管理接口

- [PUT /erp/api/model/update/{id} - 修改模块接口](#put-erp-api-model-update-id-update-5)
- [POST /erp/api/model/add - 添加模块接口](#post-erp-api-model-add-add-7)
- [GET /erp/api/model/query/{id} - 查询模块(ID)接口](#get-erp-api-model-query-id-query-14)
- [GET /erp/api/model/query-list - 查询模块(列表)接口](#get-erp-api-model-query-list-querylist-1)
- [GET /erp/api/model/query-list/specific - 查询指定行业下某个公司类型包含的模块(列表)接口](#get-erp-api-model-query-list-specific-queryspecific)

### 商户管理接口

- [PUT /erp/api/merchant/update/{id} - 修改商户接口](#put-erp-api-merchant-update-id-update-6)
- [PUT /erp/api/merchant/update-config/{id} - 修改商户配置接口](#put-erp-api-merchant-update-config-id-updateconfig)
- [PUT /erp/api/merchant/reload/initial-role-function/{id} - 重新加载商户下所有公司初始角色功能接口](#put-erp-api-merchant-reload-initial-role-function-id-reloadinitialrolefunction)
- [PUT /erp/api/merchant/manual-execution/init-data/{id} - 手工处理商户初始化接口](#put-erp-api-merchant-manual-execution-init-data-id-manualexecutioninitdata)
- [POST /erp/api/merchant/add - 添加商户接口](#post-erp-api-merchant-add-add-8)
- [GET /erp/api/merchant/query/{id} - 查询商户(ID)接口](#get-erp-api-merchant-query-id-query-15)
- [GET /erp/api/merchant/query/init-data/{id} - 查询商户初始化数据接口](#get-erp-api-merchant-query-init-data-id-queryinitdata)
- [GET /erp/api/merchant/query-page - 查询商户(分页)接口](#get-erp-api-merchant-query-page-pagequery-8)
- [GET /erp/api/merchant/query-code/{code} - 查询商户(代号)接口](#get-erp-api-merchant-query-code-code-querybycode-1)

### 菜单管理接口

- [PUT /erp/api/menu/update/{id} - 修改菜单接口](#put-erp-api-menu-update-id-update-7)
- [POST /erp/api/menu/add - 添加菜单接口](#post-erp-api-menu-add-add-9)
- [GET /erp/api/menu/query/{id} - 查询菜单(ID)接口](#get-erp-api-menu-query-id-query-16)
- [GET /erp/api/menu/query-page - 查询菜单(分页)接口](#get-erp-api-menu-query-page-pagequery-9)
- [GET /erp/api/menu/query-list - 查询菜单(列表)接口](#get-erp-api-menu-query-list-querylist-2)
- [GET /erp/api/menu/query-list/specific - 查询指定行业下某个公司类型中模块包含的菜单(列表)接口](#get-erp-api-menu-query-list-specific-queryspecific-1)
- [GET /erp/api/menu/query-code/{code} - 查询菜单(编号)接口](#get-erp-api-menu-query-code-code-querybycode-2)

### 即时通讯消息模版管理接口

- [PUT /erp/api/im-template-msg/update/{id} - 修改通讯消息模版接口](#put-erp-api-im-template-msg-update-id-update-8)
- [POST /erp/api/im-template-msg/add - 添加通讯消息模版接口](#post-erp-api-im-template-msg-add-add-10)
- [GET /erp/api/im-template-msg/query/{id} - 查询通讯消息模版(ID)接口](#get-erp-api-im-template-msg-query-id-query-17)
- [GET /erp/api/im-template-msg/query-page - 查询通讯消息模版(分页)接口](#get-erp-api-im-template-msg-query-page-query-18)

### 功能管理接口

- [PUT /erp/api/function/update/{id} - 修改功能接口](#put-erp-api-function-update-id-update-9)
- [POST /erp/api/function/add - 添加功能接口](#post-erp-api-function-add-add-11)
- [POST /erp/api/function/add/template - 添加功能模版接口](#post-erp-api-function-add-template-addtemplate)
- [POST /erp/api/function/add-fast/template - 快速添加功能模版接口](#post-erp-api-function-add-fast-template-fastaddfunctiontemplate)
- [POST /erp/api/function/add-batch/template - 添加功能模版(批量)接口](#post-erp-api-function-add-batch-template-batchaddtemplate)
- [GET /erp/api/function/query/{id} - 查询功能(ID)接口](#get-erp-api-function-query-id-query-19)
- [GET /erp/api/function/query-page - 查询功能(分页)接口](#get-erp-api-function-query-page-pagequery-10)
- [GET /erp/api/function/query-list - 查询功能(列表)接口](#get-erp-api-function-query-list-query-20)
- [GET /erp/api/function/query-list/specific - 查询特定功能(列表)接口](#get-erp-api-function-query-list-specific-query-21)
- [DELETE /erp/api/function/delete/{id} - 删除功能接口](#delete-erp-api-function-delete-id-delete-1)
- [DELETE /erp/api/function/delete/template/{merchantIndustry}/{companyType}/{functionId} - 删除指定功能模版(指定行业中公司类型所属功能)接口](#delete-erp-api-function-delete-template-merchantindustry-companytype-functionid-)
- [DELETE /erp/api/function/delete-batch/template/{merchantIndustry}/{companyType} ](#delete-erp-api-function-delete-batch-template-merchantindustry-companytype-batch)

### 快递公司管理接口

- [PUT /erp/api/express/update/{id} - 修改快递公司接口](#put-erp-api-express-update-id-update-10)
- [POST /erp/api/express/add - 添加快递公司接口](#post-erp-api-express-add-add-12)
- [GET /erp/api/express/query/{id} - 查询快递公司(ID)接口](#get-erp-api-express-query-id-query-22)
- [GET /erp/api/express/query/code/{code} - 查询快递公司(编号)接口](#get-erp-api-express-query-code-code-query-23)
- [GET /erp/api/express/query-page - 查询快递公司(分页)接口](#get-erp-api-express-query-page-querypage-1)

### 系统设备指令管理接口

- [PUT /erp/api/device-command/update/{id} - 修改系统设备指令接口](#put-erp-api-device-command-update-id-update-11)
- [POST /erp/api/device-command/add - 添加系统设备指令接口](#post-erp-api-device-command-add-add-13)
- [GET /erp/api/device-command/query - 查询系统设备指令(设备信息)接口](#get-erp-api-device-command-query-pagequery-11)
- [GET /erp/api/device-command/query/{id} - 查询系统设备指令(ID)接口](#get-erp-api-device-command-query-id-query-24)
- [GET /erp/api/device-command/query-page - 查询系统设备指令(分页)接口](#get-erp-api-device-command-query-page-pagequery-12)

### 货币管理接口

- [PUT /erp/api/currency/update/{id} - 修改货币接口](#put-erp-api-currency-update-id-update-12)
- [PUT /erp/api/currency/synchronize/currency-rate - 同步货币汇率接口](#put-erp-api-currency-synchronize-currency-rate-synchronizecurrencyrate)
- [POST /erp/api/currency/add - 添加货币接口](#post-erp-api-currency-add-add-14)
- [GET /erp/api/currency/query/{id} - 查询货币(ID)接口](#get-erp-api-currency-query-id-query-25)
- [GET /erp/api/currency/query-rate - 查询货币汇率接口](#get-erp-api-currency-query-rate-queryrate)
- [GET /erp/api/currency/query-page - 查询货币(分页)接口](#get-erp-api-currency-query-page-pagequery-13)
- [GET /erp/api/currency/query-page-rate - 查询货币汇率(分页)接口](#get-erp-api-currency-query-page-rate-queryrate-1)
- [GET /erp/api/currency/query-code/{code} - 查询货币(代号)接口](#get-erp-api-currency-query-code-code-querybycode-3)

### 商户公司管理接口

- [PUT /erp/api/company/update/{id} - 修改公司接口](#put-erp-api-company-update-id-update-13)
- [PUT /erp/api/company/reload/initial-role-function/{id} - 重新加载公司初始角色功能接口](#put-erp-api-company-reload-initial-role-function-id-reloadinitialrolefunction-1)
- [POST /erp/api/company/manual-execution/init-data/{id} - 手工处理公司初始化接口](#post-erp-api-company-manual-execution-init-data-id-manualexecutioninitdata-1)
- [POST /erp/api/company/add/{merchantId} - 添加公司接口](#post-erp-api-company-add-merchantid-add-15)
- [POST /erp/api/company/add-internal-system/{merchantId} - 添加公司接口](#post-erp-api-company-add-internal-system-merchantid-addbyinternalsystem)
- [GET /erp/api/company/query/{id} - 查询公司(ID)接口](#get-erp-api-company-query-id-query-26)
- [GET /erp/api/company/query/init-data/{id} - 查询公司初始化数据接口](#get-erp-api-company-query-init-data-id-queryinitdata-2)
- [GET /erp/api/company/query-page - 查询公司(分页)接口](#get-erp-api-company-query-page-pagequery-14)
- [GET /erp/api/company/query-other-code/{merchantId}/{otherCode} - 查询公司(其他编号)接口](#get-erp-api-company-query-other-code-merchantid-othercode-querybyother)
- [GET /erp/api/company/query-list - 查询公司(分页)接口](#get-erp-api-company-query-list-query-27)
- [GET /erp/api/company/query-code/{merchantId}/{code} - 查询公司(编号)接口](#get-erp-api-company-query-code-merchantid-code-querybycode-4)

### 系统应用管理接口

- [PUT /erp/api/application/update/{id} - 修改应用接口](#put-erp-api-application-update-id-update-14)
- [POST /erp/api/application/patch-add/api/{id} - 应用批量添加关联API接口](#post-erp-api-application-patch-add-api-id-batchaddrelevanceapi)
- [POST /erp/api/application/add - 添加应用接口](#post-erp-api-application-add-add-16)
- [GET /erp/api/application/query/{id} - 查询应用(ID)接口](#get-erp-api-application-query-id-query-28)
- [GET /erp/api/application/query-page - 查询应用(分页)接口](#get-erp-api-application-query-page-pagequery-15)
- [GET /erp/api/application/query-page/api/{id} - 查询应用关联API信息(分页)接口](#get-erp-api-application-query-page-api-id-pagequeryrelevanceapi)
- [GET /erp/api/application/query-list/api/{id} - 查询应用关联API(List)接口](#get-erp-api-application-query-list-api-id-queryallrelevanceapi)
- [GET /erp/api/application/export/api/{id} - 导出应用关联API信息接口](#get-erp-api-application-export-api-id-export)
- [DELETE /erp/api/application/patch-delete/api/{id} - 应用批量删除关联API接口](#delete-erp-api-application-patch-delete-api-id-batchdeleterelevanceapi)
- [DELETE /erp/api/application/delete/{id} - 删除应用接口](#delete-erp-api-application-delete-id-delete-2)

### APP管理接口

- [PUT /erp/api/app/withdraw/{appVersionId} - 撤回APP版本接口](#put-erp-api-app-withdraw-appversionid-withdrawappversion)
- [PUT /erp/api/app/update/{appId} - 修改APP信息接口](#put-erp-api-app-update-appid-updateapp)
- [PUT /erp/api/app/release/{appVersionId} - 发布APP版本接口](#put-erp-api-app-release-appversionid-releaseappversion)
- [PUT /erp/api/app/release/sandbox/{appVersionId} - 发布APP沙盒版本接口](#put-erp-api-app-release-sandbox-appversionid-releasesandboxappversion)
- [POST /erp/api/app/upload/app-version-file - 上传APP版本文件接口](#post-erp-api-app-upload-app-version-file-uploadappversionfile)
- [POST /erp/api/app/upload/app-version-file/stupid - 上传APP版本文件接口](#post-erp-api-app-upload-app-version-file-stupid-uploadappversionfile-1)
- [GET /erp/api/app/query - 查询当前支持的APP接口](#get-erp-api-app-query-queryapp)
- [GET /erp/api/app/query/version/{appId} - 查询APP版本信息接口](#get-erp-api-app-query-version-appid-queryapppackage)
- [GET /erp/api/app/query/support-platform-framework - 查询APP支持的平台与架构接口](#get-erp-api-app-query-support-platform-framework-queryappsupportplatformframewor)
- [GET /erp/api/app/query/support-platform-framework/{appId} - 查询APP支持的平台与架构接口](#get-erp-api-app-query-support-platform-framework-appid-queryappsupportplatformfr)
- [GET /erp/api/app/query/sandbox-version - 获取APP沙盒版本接口](#get-erp-api-app-query-sandbox-version-queryappsandboxversion)
- [GET /erp/api/app/query/last-version - 获取APP最新版本接口](#get-erp-api-app-query-last-version-queryapplastversion)
- [GET /erp/api/app/query/all-version - 获取APP全部版本接口](#get-erp-api-app-query-all-version-queryappallversion)
- [GET /erp/api/app/download/app-version-file/{shortCode} - 下载APP版本文件接口](#get-erp-api-app-download-app-version-file-shortcode-downloadappversionfile)
- [DELETE /erp/api/app/delete/{appVersionId} - 删除APP版本接口](#delete-erp-api-app-delete-appversionid-delete-3)

### 系统API管理接口

- [PUT /erp/api/api/open/{id} - 开放系统API接口](#put-erp-api-api-open-id-open)
- [PUT /erp/api/api/close/{id} - 关闭系统API接口](#put-erp-api-api-close-id-close)
- [POST /erp/api/api/refresh - 刷新服务API（swagger json地址）](#post-erp-api-api-refresh-refreshserviceapi)
- [POST /erp/api/api/refresh/file - 刷新服务API（swagger json文件）](#post-erp-api-api-refresh-file-refreshserviceapi-1)
- [GET /erp/api/api/query/{id} - 查询系统API(ID)接口](#get-erp-api-api-query-id-query-29)
- [GET /erp/api/api/query-service-list - 查询系统服务(列表)接口](#get-erp-api-api-query-service-list-queryservicelist)
- [GET /erp/api/api/query-page - 查询系统API(分页)接口](#get-erp-api-api-query-page-pagequery-16)
- [GET /erp/api/api/query-list - 查询系统API(列表)接口](#get-erp-api-api-query-list-querylist-3)
- [DELETE /erp/api/api/delete/{id} - 删除系统API接口](#delete-erp-api-api-delete-id-delete-4)
- [DELETE /erp/api/api/delete/server-code/{serverCode} - 删除系统API接口](#delete-erp-api-api-delete-server-code-servercode-delete-5)

### 地址管理接口

- [PUT /erp/api/address/upgrade/administrative-divisions - 升级五级联动数据接口](#put-erp-api-address-upgrade-administrative-divisions-upgradeadministrativedivisi)
- [PUT /erp/api/address/update/administrative-divisions/{id} - 修改五级联动数据接口](#put-erp-api-address-update-administrative-divisions-id-updateadministrativedivis)
- [POST /erp/api/address/update-province/latitude-and-longitude - 更新省份坐标数据接口](#post-erp-api-address-update-province-latitude-and-longitude-updateprovincelatitu)
- [POST /erp/api/address/query-address-by-ip - 根据ip查询地址接口](#post-erp-api-address-query-address-by-ip-queryaddressbyip)
- [POST /erp/api/address/insert/other-country-address - 写入其他国家地址信息](#post-erp-api-address-insert-other-country-address-insertothercountryaddress)
- [POST /erp/api/address/init-country-data - 初始化国家信息接口](#post-erp-api-address-init-country-data-initcountrydata)
- [POST /erp/api/address/add/administrative-divisions - 增加五级联动数据接口](#post-erp-api-address-add-administrative-divisions-addadministrativedivisions)
- [GET /erp/api/address/query/administrative-divisions - 获取五级联动数据接口](#get-erp-api-address-query-administrative-divisions-getadministrativedivisions)

### 会计科目管理接口

- [PUT /erp/api/accounting/update/type/{accountingTypeId} - 修改会计科目类别接口](#put-erp-api-accounting-update-type-accountingtypeid-updateaccountingtype)
- [PUT /erp/api/accounting/update/title/{accountingTitleId} - 修改会计科目接口](#put-erp-api-accounting-update-title-accountingtitleid-updateaccountingtitle)
- [POST /erp/api/accounting/add/type - 添加会计科目类别接口](#post-erp-api-accounting-add-type-addaccountingtype)
- [POST /erp/api/accounting/add/title - 添加会计科目接口](#post-erp-api-accounting-add-title-addaccountingtitle)
- [GET /erp/api/accounting/query/type/{accountingTypeId} - 查询会计科目类别(ID)接口](#get-erp-api-accounting-query-type-accountingtypeid-querytype)
- [GET /erp/api/accounting/query/type/code/{typeCode} - 查询会计科目类别(代号)接口](#get-erp-api-accounting-query-type-code-typecode-querytype-1)
- [GET /erp/api/accounting/query/title/{accountingTitleId} - 查询会计科目(ID)接口](#get-erp-api-accounting-query-title-accountingtitleid-querytitle)
- [GET /erp/api/accounting/query/title/code/{titleCode} - 查询会计科目(代号)接口](#get-erp-api-accounting-query-title-code-titlecode-querytitle-1)
- [GET /erp/api/accounting/query-page/title - 查询会计科目类别(分页)接口](#get-erp-api-accounting-query-page-title-querytitle-2)
- [GET /erp/api/accounting/query-list/type - 查询会计科目类别(List)接口](#get-erp-api-accounting-query-list-type-querytype-2)

### 系统公用属性

- [PUT /api/sys/property/update - 编辑系统属性](#put-api-sys-property-update-update-15)
- [POST /api/sys/property/add - 添加系统属性](#post-api-sys-property-add-add-17)
- [GET /api/sys/property/page - 查询系统属性列表(分页)](#get-api-sys-property-page-page)
- [GET /api/sys/property/list - 查询系统属性列表](#get-api-sys-property-list-list)
- [GET /api/sys/property/list/{group} - 查询系统属性列表](#get-api-sys-property-list-group-list-1)
- [GET /api/sys/property/get - 查询系统属性](#get-api-sys-property-get-query-30)

### 登录管理

- [POST /sys/api/token-reflash - token刷新接口](#post-sys-api-token-reflash-tokenreflash)
- [POST /sys/api/login - 登录接口](#post-sys-api-login-login)

### 登出管理

- [POST /sys/api/logout - 登出接口](#post-sys-api-logout-logout)

### 验证码管理

- [POST /sys/api/captcha/send-email-captcha/{account} - 发送账号验证码接口](#post-sys-api-captcha-send-email-captcha-account-sendcaptchaforaccount)

### 服务管理接口

- [POST /server-manager/upload/server-file/to-appoint-directory - 上传服务文件到指定目录接口](#post-server-manager-upload-server-file-to-appoint-directory-uploadserverfiletoap)
- [POST /server-manager/execute/non-interactive/command - 执行非交互性指令接口](#post-server-manager-execute-non-interactive-command-executenoninteractivecommand)

### 系统导入模版管理接口

- [POST /erp/api/sys-import-template/upload/{type} - 上传系统导入模版接口](#post-erp-api-sys-import-template-upload-type-uploadmultipartfile-1)
- [GET /erp/api/sys-import-template/query/{id} - 查询系统导入模版(ID)接口](#get-erp-api-sys-import-template-query-id-query-8)
- [GET /erp/api/sys-import-template/query/type - 查询系统导入模版(类型)接口](#get-erp-api-sys-import-template-query-type-querybytype)
- [GET /erp/api/sys-import-template/query-list - 查询系统导入模版(列表)接口](#get-erp-api-sys-import-template-query-list-querylist)
- [DELETE /erp/api/sys-import-template/remove/{id} - 删除系统导入模版接口](#delete-erp-api-sys-import-template-remove-id-remove-1)

### 敏感字管理接口

- [POST /erp/api/sensitive-word/add/deny - 添加敏感词黑名单接口](#post-erp-api-sensitive-word-add-deny-adddeny)
- [POST /erp/api/sensitive-word/add/allow - 添加敏感词白名单接口](#post-erp-api-sensitive-word-add-allow-addallow)
- [GET /erp/api/sensitive-word/query-page - 查询敏感词接口](#get-erp-api-sensitive-word-query-page-querypage)
- [DELETE /erp/api/sensitive-word/delete/deny - 删除敏感词黑名单接口](#delete-erp-api-sensitive-word-delete-deny-deletedeny)
- [DELETE /erp/api/sensitive-word/delete/allow - 删除敏感词白名单接口](#delete-erp-api-sensitive-word-delete-allow-deleteallow)

### 商户角色管理接口

- [POST /erp/api/role/patch-add/user/{id} - 角色批量添加用户接口](#post-erp-api-role-patch-add-user-id-patchadduser)
- [POST /erp/api/role/patch-add/function/{id} - 角色批量添加功能接口](#post-erp-api-role-patch-add-function-id-patchaddfunction)
- [GET /erp/api/role/query/{id} - 查询角色(ID)接口](#get-erp-api-role-query-id-query-10)
- [GET /erp/api/role/query-page - 查询角色(分页)接口](#get-erp-api-role-query-page-pagequery-6)
- [GET /erp/api/role/query-page/user/{id} - 查询角色用户信息(分页)接口](#get-erp-api-role-query-page-user-id-pagequeryuser)
- [GET /erp/api/role/query-page/function/{id} - 查询角色功能信息(分页)接口](#get-erp-api-role-query-page-function-id-pagequeryfunction)
- [GET /erp/api/role/query-list/user/{id} - 查询角色用户信息(列表)接口](#get-erp-api-role-query-list-user-id-querylistuser)
- [GET /erp/api/role/query-list/function/{id} - 查询角色功能信息(列表)接口](#get-erp-api-role-query-list-function-id-querylistfunction)
- [DELETE /erp/api/role/patch-delete/user/{id} - 角色批量删除用户接口](#delete-erp-api-role-patch-delete-user-id-patchdeleteuser)
- [DELETE /erp/api/role/patch-delete/function/{id} - 角色批量删除功能接口](#delete-erp-api-role-patch-delete-function-id-patchdeletefunction)

### 商户初始化管理接口

- [POST /erp/api/merchant-init/add-sql - 添加系统初始化商户(Sql)数据接口](#post-erp-api-merchant-init-add-sql-addforsql)
- [POST /erp/api/merchant-init/add-interface - 添加系统初始化商户(接口)数据接口](#post-erp-api-merchant-init-add-interface-addforinterface)
- [POST /erp/api/merchant-init/add-entity - 添加系统初始化商户(实体类)数据接口](#post-erp-api-merchant-init-add-entity-addforentity)
- [GET /erp/api/merchant-init/query - 查询系统初始化商户数据接口](#get-erp-api-merchant-init-query-queryinitdata-1)
- [DELETE /erp/api/merchant-init/delete/{id} - 删除系统初始化商户数据接口](#delete-erp-api-merchant-init-delete-id-deleteinitdata)

### 国际化管理

- [POST /erp/api/i18n/setting - 设置国际化翻译字典接口](#post-erp-api-i18n-setting-settingtranslation)
- [POST /erp/api/i18n/query/lang - 查询语言接口](#post-erp-api-i18n-query-lang-querylang)
- [GET /erp/api/i18n/query/translation/{lang}/{industry} - 查询国际化翻译字典接口](#get-erp-api-i18n-query-translation-lang-industry-querytranslation)

### 公司初始化管理接口

- [POST /erp/api/company-init/add-sql - 添加系统初始化公司(Sql)数据接口](#post-erp-api-company-init-add-sql-addforsql-1)
- [POST /erp/api/company-init/add-interface - 添加系统初始化公司(接口)数据接口](#post-erp-api-company-init-add-interface-addforinterface-1)
- [POST /erp/api/company-init/add-entity - 添加系统初始化公司(实体类)数据接口](#post-erp-api-company-init-add-entity-addforentity-1)
- [GET /erp/api/company-init/query/init-data - 查询系统初始化公司数据接口](#get-erp-api-company-init-query-init-data-queryinitdata-3)
- [DELETE /erp/api/company-init/delete/init-data/{id} - 删除系统初始化公司数据接口](#delete-erp-api-company-init-delete-init-data-id-deleteinitdata-1)

### 导入商户初始数据接口

- [GET /erp/api/imp-merchant-init-data/query/{merchantId} - 查询商户初始数据导入结果接口](#get-erp-api-imp-merchant-init-data-query-merchantid-queryimpdataprocessresult)
- [GET /erp/api/imp-merchant-init-data/query/support-imp-data-type - 查询支持商户导入的初始数据类型接口](#get-erp-api-imp-merchant-init-data-query-support-imp-data-type-querysupportimpda)
- [GET /erp/api/imp-merchant-init-data/query/all-support-imp-data/import-finish-status/{merchantId} - 查询商户所有可以导入的数据导入状态接口](#get-erp-api-imp-merchant-init-data-query-all-support-imp-data-import-finish-stat)

### 服务监控管理

- [GET /api/monitor/version - 获取服务版本信息](#get-api-monitor-version-version)
- [GET /api/monitor/health - 心跳检查](#get-api-monitor-health-health)

### main-site-error-handler

- [GET /error ](#get-error-handleerror)
- [POST /error ](#post-error-handleerror-1)
- [PUT /error ](#put-error-handleerror-2)
- [DELETE /error ](#delete-error-handleerror-3)
- [PATCH /error ](#patch-error-handleerror-4)
- [OPTIONS /error ](#options-error-handleerror-6)
- [HEAD /error ](#head-error-handleerror-5)


## 接口详情

<a id="put-sys-api-user-update-password-id-updatepassword"></a>

### 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 | 否 | 返回数据 |  |

<a id="put-sys-api-user-update-info-id-updateinfo"></a>

### 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 | 否 |  |  |

<a id="put-sys-api-user-forgot-password-forgotpassword"></a>

### 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 | 否 | 返回数据 |  |

<a id="put-sys-api-user-activation-updatepassword-1"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-sys-api-user-registration-registration"></a>

### 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 | 否 |  |  |

<a id="get-sys-api-user-query-id-query"></a>

### 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 | 否 |  |  |

<a id="get-sys-api-user-query-page-query-1"></a>

### 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 | 否 |  |  |

<a id="get-sys-api-user-query-account-account-query-2"></a>

### 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 | 否 |  |  |

<a id="put-erp-api-version-manager-update-id-update"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-version-manager-add-add"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-version-manager-query-page-pagequery"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-version-manager-query-list-query-3"></a>

### 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[] | 否 | 返回数据 |  |

<a id="put-erp-api-user-update-readversioninfo-updateuserreadversioninfo"></a>

### 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 | 否 | 返回数据 |  |

<a id="get-erp-api-user-query-id-query-4"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-user-query-page-pagequery-1"></a>

### 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 | 否 |  |  |

<a id="delete-erp-api-user-clear-redis-user-permissions-id-clearredisuserpermissions"></a>

### 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 | 否 | 返回数据 |  |

<a id="put-erp-api-uom-update-id-update-1"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-uom-upload-uploadmultipartfile"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-erp-api-uom-add-add-1"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-uom-query-id-query-5"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-uom-query-page-pagequery-2"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-uom-query-code-code-querybycode"></a>

### 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 | 否 |  |  |

<a id="put-erp-api-sys-printer-template-update-id-update-2"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-sys-printer-template-add-report-add-2"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-sys-printer-template-add-receipt-add-3"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-sys-printer-template-add-label-add-4"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-sys-printer-template-query-id-query-6"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-sys-printer-template-query-target-querytarget"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-sys-printer-template-query-page-pagequery-3"></a>

### 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 | 否 |  |  |

<a id="put-erp-api-sys-operational-doc-update-custom-menu-doc-docid-updatecustommenuope"></a>

### PUT /erp/api/sys-operational-doc/update/custom-menu/doc/{docId}

- 分组：系统操作文档管理接口
- 名称：修改自定义菜单操作文档接口
- OperationId：updateCustomMenuOperationalDoc

#### 调用方法

`PUT /erp/api/sys-operational-doc/update/custom-menu/doc/{docId}`

#### 参数

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

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：UpdateCustomMenuOperationalDocDTO（com.leadwaycloud.manager.business.operational.doc.dto.UpdateCustomMenuOperationalDocDTO）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| industry | string | 否 | 行业  【 COMPLEX : 大型购物中心;多种经营联合体;跨行业经营集团   TRADE : 商贸经营企业   RETAIL : 商超经营企业   RESTAURANT : 餐饮企业   FOOD : 餐饮企业   ENERGY : 加油、气、店站   OIL : 加油、气、店站   CRUISE : 邮轮旅游   PLAYGROUND : 游乐场综合体   MANUFACTURING : 生产制造业   】 | "COMPLEX" |
| modelId | integer(int64) | 否 | 系统模块ID |  |
| customMenu | string | 否 | 自定义菜单 | "1" |

#### 响应


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

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

<a id="post-erp-api-sys-operational-doc-init-sys-menu-doc-initsysmenuoperationaldoc"></a>

### POST /erp/api/sys-operational-doc/init/sys-menu/doc

- 分组：系统操作文档管理接口
- 名称：初始化系统菜单操作文档接口
- OperationId：initSysMenuOperationalDoc
- 描述：异步接口

#### 调用方法

`POST /erp/api/sys-operational-doc/init/sys-menu/doc`

#### 参数

无

#### 请求体

无

#### 响应


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

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

<a id="post-erp-api-sys-operational-doc-add-menu-operational-doc-file-docid-langid-addm"></a>

### POST /erp/api/sys-operational-doc/add/menu-operational-doc-file/{docId}/{langId}

- 分组：系统操作文档管理接口
- 名称：上传系统操作文档文件接口
- OperationId：addMenuOperationalDocFile

#### 调用方法

`POST /erp/api/sys-operational-doc/add/menu-operational-doc-file/{docId}/{langId}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| docId | path | 是 | integer(int64) | 文档id |  |
| langId | path | 是 | integer(int64) | 语言id |  |

#### 请求体


- Content-Type：`multipart/form-data`
- 必填：否
- 类型：object

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| importTemplateFile | 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 | 否 | 返回数据 |  |

<a id="post-erp-api-sys-operational-doc-add-custom-menu-doc-addcustommenuoperationaldoc"></a>

### POST /erp/api/sys-operational-doc/add/custom-menu/doc

- 分组：系统操作文档管理接口
- 名称：添加自定义菜单操作文档接口
- OperationId：addCustomMenuOperationalDoc

#### 调用方法

`POST /erp/api/sys-operational-doc/add/custom-menu/doc`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：AddCustomMenuOperationalDocDTO（com.leadwaycloud.manager.business.operational.doc.dto.AddCustomMenuOperationalDocDTO）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| industry | string | 是 | 行业  【 COMPLEX : 大型购物中心;多种经营联合体;跨行业经营集团   TRADE : 商贸经营企业   RETAIL : 商超经营企业   RESTAURANT : 餐饮企业   FOOD : 餐饮企业   ENERGY : 加油、气、店站   OIL : 加油、气、店站   CRUISE : 邮轮旅游   PLAYGROUND : 游乐场综合体   MANUFACTURING : 生产制造业   】 | "COMPLEX" |
| modelId | integer(int64) | 是 | 系统模块ID |  |
| customMenu | string | 是 | 自定义菜单 | "1" |

#### 响应


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

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

<a id="get-erp-api-sys-operational-doc-query-id-query-7"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-sys-operational-doc-query-page-pagequery-4"></a>

### 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 | 否 |  |  |

<a id="delete-erp-api-sys-operational-doc-remove-menu-operational-doc-file-dockerdetail"></a>

### DELETE /erp/api/sys-operational-doc/remove/menu-operational-doc-file/{dockerDetailId}

- 分组：系统操作文档管理接口
- 名称：删除系统操作文档文件接口
- OperationId：remove
- 描述：物理删除

#### 调用方法

`DELETE /erp/api/sys-operational-doc/remove/menu-operational-doc-file/{dockerDetailId}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| dockerDetailId | path | 是 | integer(int64) | 文档详情id | 1 |

#### 请求体

无

#### 响应


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

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

<a id="delete-erp-api-sys-operational-doc-remove-custom-menu-doc-docid-removecustommenu"></a>

### DELETE /erp/api/sys-operational-doc/remove/custom-menu/doc/{docId}

- 分组：系统操作文档管理接口
- 名称：删除自定义菜单操作文档接口
- OperationId：removeCustomMenuOperationalDoc

#### 调用方法

`DELETE /erp/api/sys-operational-doc/remove/custom-menu/doc/{docId}`

#### 参数

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

#### 请求体

无

#### 响应


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

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

<a id="put-erp-api-setting-delete-id-delete"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-erp-api-setting-add-add-5"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-setting-query-id-query-9"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-setting-query-page-pagequery-5"></a>

### 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 | 否 |  |  |

<a id="put-erp-api-report-update-id-update-3"></a>

### 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 | 否 |  |  |

<a id="put-erp-api-report-update-view-config-reportviewconfigid-updatereportviewconfig"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-report-add-add-6"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-report-add-view-config-id-addreportviewconfig"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-report-query-id-query-11"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-report-query-view-config-id-queryreportviewconfig"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-report-query-page-query-12"></a>

### 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 | 否 |  |  |

<a id="delete-erp-api-report-remove-id-remove-2"></a>

### 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 | 否 | 返回数据 |  |

<a id="delete-erp-api-report-remove-view-config-reportviewconfigid-removereportviewconf"></a>

### 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 | 否 | 返回数据 |  |

<a id="put-erp-api-platform-version-manager-update-id-update-4"></a>

### PUT /erp/api/platform-version-manager/update/{id}

- 分组：平台版本管理
- 名称：编辑平台版本接口
- OperationId：update_4

#### 调用方法

`PUT /erp/api/platform-version-manager/update/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 平台版本ID | 1 |

#### 请求体


- 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 | 否 |  |  |

<a id="post-erp-api-platform-version-manager-confirm-platform-version-userid-confirmpla"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-erp-api-platform-version-manager-add-addplatformversion"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-platform-version-manager-query-user-un-confirm-platform-version-user"></a>

### GET /erp/api/platform-version-manager/query-user-un-confirm-platform-version/{userId}/{businessCompanyId}

- 分组：平台版本管理
- 名称：查询用户未确认的平台版本信息
- OperationId：queryUserUnConfirmPlatformVersion

#### 调用方法

`GET /erp/api/platform-version-manager/query-user-un-confirm-platform-version/{userId}/{businessCompanyId}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| userId | path | 是 | integer(int64) | 用户ID | 1 |
| businessCompanyId | path | 是 | integer(int64) | 业务公司ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SysPlatformVersion（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.platform.version.entity.SysPlatformVersion）

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

<a id="get-erp-api-platform-version-manager-query-page-pagequery-7"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-platform-version-manager-query-model-version-querymodelversion"></a>

### GET /erp/api/platform-version-manager/query-model-version

- 分组：平台版本管理
- 名称：查询平台版本(分页)接口
- OperationId：queryModelVersion

#### 调用方法

`GET /erp/api/platform-version-manager/query-model-version`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| model | query | 是 | string | 模块(ID/编号/名称) | "system" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SysPlatformModelVersionVO（com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.platform.version.vo.SysPlatformModelVersionVO）

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

<a id="get-erp-api-platform-version-manager-query-list-query-13"></a>

### GET /erp/api/platform-version-manager/query-list

- 分组：平台版本管理
- 名称：查询平台版本(列表)接口
- OperationId：query_13

#### 调用方法

`GET /erp/api/platform-version-manager/query-list`

#### 参数

无

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SysPlatformVersion（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.platform.version.entity.SysPlatformVersion）

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

<a id="get-erp-api-platform-version-manager-query-list-subversion-id-queryplatformversi"></a>

### GET /erp/api/platform-version-manager/query-list-subversion/{id}

- 分组：平台版本管理
- 名称：查询平台版本下后端服务版本信息
- OperationId：queryPlatformVersionServiceInfo

#### 调用方法

`GET /erp/api/platform-version-manager/query-list-subversion/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 平台版本ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SysVersionVO（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.platform.version.vo.SysVersionVO）

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

<a id="get-erp-api-platform-version-manager-query-fresh-version-queryfreshplatformversi"></a>

### GET /erp/api/platform-version-manager/query-fresh-version

- 分组：平台版本管理
- 名称：查询最新平台版本信息接口
- OperationId：queryFreshPlatformVersion

#### 调用方法

`GET /erp/api/platform-version-manager/query-fresh-version`

#### 参数

无

#### 请求体

无

#### 响应


- 状态码：`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 | 否 |  |  |

<a id="put-erp-api-model-update-id-update-5"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-model-add-add-7"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-model-query-id-query-14"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-model-query-list-querylist-1"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-erp-api-model-query-list-specific-queryspecific"></a>

### 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[] | 否 | 返回数据 |  |

<a id="put-erp-api-merchant-update-id-update-6"></a>

### 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 | 否 |  |  |

<a id="put-erp-api-merchant-update-config-id-updateconfig"></a>

### 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 | 否 |  |  |

<a id="put-erp-api-merchant-reload-initial-role-function-id-reloadinitialrolefunction"></a>

### 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 | 否 | 返回数据 |  |

<a id="put-erp-api-merchant-manual-execution-init-data-id-manualexecutioninitdata"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-erp-api-merchant-add-add-8"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-merchant-query-id-query-15"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-merchant-query-init-data-id-queryinitdata"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-erp-api-merchant-query-page-pagequery-8"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-merchant-query-code-code-querybycode-1"></a>

### 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 | 否 |  |  |

<a id="put-erp-api-menu-update-id-update-7"></a>

### PUT /erp/api/menu/update/{id}

- 分组：菜单管理接口
- 名称：修改菜单接口
- OperationId：update_7

#### 调用方法

`PUT /erp/api/menu/update/{id}`

#### 参数

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

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：UpdateMenuDTO（com.leadwaycloud.manager.business.menu.dto.UpdateMenuDTO）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| code | string | 否 | 编号 | "HR" |
| name | string | 否 | 名称 | "认识" |
| active | boolean | 否 | 是否可用 | true |
| description | string | 否 | 描述 |  |
| filter | string | 否 | 根据参数过滤菜单 |  |
| button | string | 否 | 菜单下的按钮json |  |
| image | string | 否 | 图标 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SysMenu（com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.menu.entity.SysMenu）

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

<a id="post-erp-api-menu-add-add-9"></a>

### POST /erp/api/menu/add

- 分组：菜单管理接口
- 名称：添加菜单接口
- OperationId：add_9

#### 调用方法

`POST /erp/api/menu/add`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：AddMenuDTO（com.leadwaycloud.manager.business.menu.dto.AddMenuDTO）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| code | string | 是 | 编号 | "HR" |
| name | string | 是 | 名称 | "认识" |
| description | string | 否 | 描述 |  |
| filter | string | 是 | 根据参数过滤菜单 |  |
| button | string | 是 | 菜单下的按钮json |  |
| image | string | 否 | 图标 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SysMenu（com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.menu.entity.SysMenu）

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

<a id="get-erp-api-menu-query-id-query-16"></a>

### GET /erp/api/menu/query/{id}

- 分组：菜单管理接口
- 名称：查询菜单(ID)接口
- OperationId：query_16

#### 调用方法

`GET /erp/api/menu/query/{id}`

#### 参数

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

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SysMenu（com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.menu.entity.SysMenu）

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

<a id="get-erp-api-menu-query-page-pagequery-9"></a>

### GET /erp/api/menu/query-page

- 分组：菜单管理接口
- 名称：查询菜单(分页)接口
- OperationId：pageQuery_9

#### 调用方法

`GET /erp/api/menu/query-page`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| code | query | 否 | string | 编号 | "HR" |
| name | query | 否 | string | 名称 | "认识" |
| active | query | 否 | boolean | 是否可用 | true |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SysMenu（com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.menu.entity.SysMenu）

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

<a id="get-erp-api-menu-query-list-querylist-2"></a>

### GET /erp/api/menu/query-list

- 分组：菜单管理接口
- 名称：查询菜单(列表)接口
- OperationId：queryList_2

#### 调用方法

`GET /erp/api/menu/query-list`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| code | query | 否 | string | 编号 | "HR" |
| name | query | 否 | string | 名称 | "认识" |
| active | query | 否 | boolean | 是否可用 | true |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SysMenu（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.menu.entity.SysMenu）

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

<a id="get-erp-api-menu-query-list-specific-queryspecific-1"></a>

### GET /erp/api/menu/query-list/specific

- 分组：菜单管理接口
- 名称：查询指定行业下某个公司类型中模块包含的菜单(列表)接口
- OperationId：querySpecific_1

#### 调用方法

`GET /erp/api/menu/query-list/specific`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| merchantIndustry | query | 是 | string | 商户行业 | "COMPLEX" |
| companyType | query | 是 | string | 公司类型 | "MERCHANT" |
| modelId | query | 是 | integer(int64) | 模块ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SysMenu（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.menu.entity.SysMenu）

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

<a id="get-erp-api-menu-query-code-code-querybycode-2"></a>

### GET /erp/api/menu/query-code/{code}

- 分组：菜单管理接口
- 名称：查询菜单(编号)接口
- OperationId：queryByCode_2

#### 调用方法

`GET /erp/api/menu/query-code/{code}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| code | path | 是 | string | 编号 | "xxx" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SysMenu（com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.menu.entity.SysMenu）

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

<a id="put-erp-api-im-template-msg-update-id-update-8"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-im-template-msg-add-add-10"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-im-template-msg-query-id-query-17"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-im-template-msg-query-page-query-18"></a>

### 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 | 否 |  |  |

<a id="put-erp-api-function-update-id-update-9"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-function-add-add-11"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-function-add-template-addtemplate"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-function-add-fast-template-fastaddfunctiontemplate"></a>

### 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[] | 否 | 返回数据 |  |

<a id="post-erp-api-function-add-batch-template-batchaddtemplate"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-erp-api-function-query-id-query-19"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-function-query-page-pagequery-10"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-function-query-list-query-20"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-erp-api-function-query-list-specific-query-21"></a>

### 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[] | 否 | 返回数据 |  |

<a id="delete-erp-api-function-delete-id-delete-1"></a>

### 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 | 否 | 返回数据 |  |

<a id="delete-erp-api-function-delete-template-merchantindustry-companytype-functionid-"></a>

### 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 | 否 | 返回数据 |  |

<a id="delete-erp-api-function-delete-batch-template-merchantindustry-companytype-batch"></a>

### 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 | 否 | 返回数据 |  |

<a id="put-erp-api-express-update-id-update-10"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-express-add-add-12"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-express-query-id-query-22"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-express-query-code-code-query-23"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-express-query-page-querypage-1"></a>

### 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 | 否 |  |  |

<a id="put-erp-api-device-command-update-id-update-11"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-device-command-add-add-13"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-device-command-query-pagequery-11"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-device-command-query-id-query-24"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-device-command-query-page-pagequery-12"></a>

### 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 | 否 |  |  |

<a id="put-erp-api-currency-update-id-update-12"></a>

### 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 | 否 |  |  |

<a id="put-erp-api-currency-synchronize-currency-rate-synchronizecurrencyrate"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-erp-api-currency-add-add-14"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-currency-query-id-query-25"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-currency-query-rate-queryrate"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-currency-query-page-pagequery-13"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-currency-query-page-rate-queryrate-1"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-currency-query-code-code-querybycode-3"></a>

### 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 | 否 |  |  |

<a id="put-erp-api-company-update-id-update-13"></a>

### 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 | 否 |  |  |

<a id="put-erp-api-company-reload-initial-role-function-id-reloadinitialrolefunction-1"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-erp-api-company-manual-execution-init-data-id-manualexecutioninitdata-1"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-erp-api-company-add-merchantid-add-15"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-company-add-internal-system-merchantid-addbyinternalsystem"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-company-query-id-query-26"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-company-query-init-data-id-queryinitdata-2"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-erp-api-company-query-page-pagequery-14"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-company-query-other-code-merchantid-othercode-querybyother"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-company-query-list-query-27"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-erp-api-company-query-code-merchantid-code-querybycode-4"></a>

### 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 | 否 |  |  |

<a id="put-erp-api-application-update-id-update-14"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-application-patch-add-api-id-batchaddrelevanceapi"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-application-add-add-16"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-application-query-id-query-28"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-application-query-page-pagequery-15"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-application-query-page-api-id-pagequeryrelevanceapi"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-application-query-list-api-id-queryallrelevanceapi"></a>

### 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)[] | 否 | 返回数据 |  |

<a id="get-erp-api-application-export-api-id-export"></a>

### 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)

无

<a id="delete-erp-api-application-patch-delete-api-id-batchdeleterelevanceapi"></a>

### 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 | 否 |  |  |

<a id="delete-erp-api-application-delete-id-delete-2"></a>

### 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 | 否 | 返回数据 |  |

<a id="put-erp-api-app-withdraw-appversionid-withdrawappversion"></a>

### 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 | 否 | 返回数据 |  |

<a id="put-erp-api-app-update-appid-updateapp"></a>

### 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 | 否 | 返回数据 |  |

<a id="put-erp-api-app-release-appversionid-releaseappversion"></a>

### 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 | 否 | 返回数据 |  |

<a id="put-erp-api-app-release-sandbox-appversionid-releasesandboxappversion"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-erp-api-app-upload-app-version-file-uploadappversionfile"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-erp-api-app-upload-app-version-file-stupid-uploadappversionfile-1"></a>

### 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 | 否 | 返回数据 |  |

<a id="get-erp-api-app-query-queryapp"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-erp-api-app-query-version-appid-queryapppackage"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-app-query-support-platform-framework-queryappsupportplatformframewor"></a>

### GET /erp/api/app/query/support-platform-framework

- 分组：APP管理接口
- 名称：查询APP支持的平台与架构接口
- OperationId：queryAppSupportPlatformFramework

#### 调用方法

`GET /erp/api/app/query/support-platform-framework`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| appCode | query | 是 | string | APP代号 | "xxx" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：APPPlatformFrameworkVO（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.app.vo.APPPlatformFrameworkVO）

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

<a id="get-erp-api-app-query-support-platform-framework-appid-queryappsupportplatformfr"></a>

### GET /erp/api/app/query/support-platform-framework/{appId}

- 分组：APP管理接口
- 名称：查询APP支持的平台与架构接口
- OperationId：queryAppSupportPlatformFramework_1

#### 调用方法

`GET /erp/api/app/query/support-platform-framework/{appId}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| appId | path | 是 | string | APP ID | "xxx" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：APPPlatformFrameworkVO（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.app.vo.APPPlatformFrameworkVO）

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

<a id="get-erp-api-app-query-sandbox-version-queryappsandboxversion"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-app-query-last-version-queryapplastversion"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-app-query-all-version-queryappallversion"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-erp-api-app-download-app-version-file-shortcode-downloadappversionfile"></a>

### 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" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK

无

<a id="delete-erp-api-app-delete-appversionid-delete-3"></a>

### 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 | 否 | 返回数据 |  |

<a id="put-erp-api-api-open-id-open"></a>

### 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 | 否 | 返回数据 |  |

<a id="put-erp-api-api-close-id-close"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-erp-api-api-refresh-refreshserviceapi"></a>

### 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[] | 否 | 返回数据 |  |

<a id="post-erp-api-api-refresh-file-refreshserviceapi-1"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-erp-api-api-query-id-query-29"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-api-query-service-list-queryservicelist"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-erp-api-api-query-page-pagequery-16"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-api-query-list-querylist-3"></a>

### 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[] | 否 | 返回数据 |  |

<a id="delete-erp-api-api-delete-id-delete-4"></a>

### 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 | 否 | 返回数据 |  |

<a id="delete-erp-api-api-delete-server-code-servercode-delete-5"></a>

### 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 | 否 | 返回数据 |  |

<a id="put-erp-api-address-upgrade-administrative-divisions-upgradeadministrativedivisi"></a>

### 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 | 否 | 返回数据 |  |

<a id="put-erp-api-address-update-administrative-divisions-id-updateadministrativedivis"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-erp-api-address-update-province-latitude-and-longitude-updateprovincelatitu"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-erp-api-address-query-address-by-ip-queryaddressbyip"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-erp-api-address-insert-other-country-address-insertothercountryaddress"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-erp-api-address-init-country-data-initcountrydata"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-erp-api-address-add-administrative-divisions-addadministrativedivisions"></a>

### 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 | 否 | 返回数据 |  |

<a id="get-erp-api-address-query-administrative-divisions-getadministrativedivisions"></a>

### 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[] | 否 | 返回数据 |  |

<a id="put-erp-api-accounting-update-type-accountingtypeid-updateaccountingtype"></a>

### 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 | 否 |  |  |

<a id="put-erp-api-accounting-update-title-accountingtitleid-updateaccountingtitle"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-accounting-add-type-addaccountingtype"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-accounting-add-title-addaccountingtitle"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-accounting-query-type-accountingtypeid-querytype"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-accounting-query-type-code-typecode-querytype-1"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-accounting-query-title-accountingtitleid-querytitle"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-accounting-query-title-code-titlecode-querytitle-1"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-accounting-query-page-title-querytitle-2"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-accounting-query-list-type-querytype-2"></a>

### 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[] | 否 | 返回数据 |  |

<a id="put-api-sys-property-update-update-15"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-api-sys-property-add-add-17"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-api-sys-property-page-page"></a>

### 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 | 否 |  |  |

<a id="get-api-sys-property-list-list"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-api-sys-property-list-group-list-1"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-api-sys-property-get-query-30"></a>

### 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 | 否 |  |  |

<a id="post-sys-api-token-reflash-tokenreflash"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-sys-api-login-login"></a>

### 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 | 否 |  |  |

<a id="post-sys-api-logout-logout"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-sys-api-captcha-send-email-captcha-account-sendcaptchaforaccount"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-server-manager-upload-server-file-to-appoint-directory-uploadserverfiletoap"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-server-manager-execute-non-interactive-command-executenoninteractivecommand"></a>

### 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[] | 否 | 返回数据 |  |

<a id="post-erp-api-sys-import-template-upload-type-uploadmultipartfile-1"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-sys-import-template-query-id-query-8"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-sys-import-template-query-type-querybytype"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-sys-import-template-query-list-querylist"></a>

### 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[] | 否 | 返回数据 |  |

<a id="delete-erp-api-sys-import-template-remove-id-remove-1"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-erp-api-sensitive-word-add-deny-adddeny"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-erp-api-sensitive-word-add-allow-addallow"></a>

### 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 | 否 | 返回数据 |  |

<a id="get-erp-api-sensitive-word-query-page-querypage"></a>

### 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 | 否 |  |  |

<a id="delete-erp-api-sensitive-word-delete-deny-deletedeny"></a>

### 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 | 否 | 返回数据 |  |

<a id="delete-erp-api-sensitive-word-delete-allow-deleteallow"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-erp-api-role-patch-add-user-id-patchadduser"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-role-patch-add-function-id-patchaddfunction"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-role-query-id-query-10"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-role-query-page-pagequery-6"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-role-query-page-user-id-pagequeryuser"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-role-query-page-function-id-pagequeryfunction"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-role-query-list-user-id-querylistuser"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-erp-api-role-query-list-function-id-querylistfunction"></a>

### 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[] | 否 | 返回数据 |  |

<a id="delete-erp-api-role-patch-delete-user-id-patchdeleteuser"></a>

### 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 | 否 |  |  |

<a id="delete-erp-api-role-patch-delete-function-id-patchdeletefunction"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-merchant-init-add-sql-addforsql"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-merchant-init-add-interface-addforinterface"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-merchant-init-add-entity-addforentity"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-merchant-init-query-queryinitdata-1"></a>

### 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[] | 否 | 返回数据 |  |

<a id="delete-erp-api-merchant-init-delete-id-deleteinitdata"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-erp-api-i18n-setting-settingtranslation"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-erp-api-i18n-query-lang-querylang"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-erp-api-i18n-query-translation-lang-industry-querytranslation"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-company-init-add-sql-addforsql-1"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-company-init-add-interface-addforinterface-1"></a>

### 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 | 否 |  |  |

<a id="post-erp-api-company-init-add-entity-addforentity-1"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-company-init-query-init-data-queryinitdata-3"></a>

### 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[] | 否 | 返回数据 |  |

<a id="delete-erp-api-company-init-delete-init-data-id-deleteinitdata-1"></a>

### 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 | 否 | 返回数据 |  |

<a id="get-erp-api-imp-merchant-init-data-query-merchantid-queryimpdataprocessresult"></a>

### 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 | 否 |  |  |

<a id="get-erp-api-imp-merchant-init-data-query-support-imp-data-type-querysupportimpda"></a>

### 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[] | 否 | 返回数据 |  |

<a id="get-erp-api-imp-merchant-init-data-query-all-support-imp-data-import-finish-stat"></a>

### 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 | 否 | 返回数据 |  |

<a id="get-api-monitor-version-version"></a>

### 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 | 否 | 返回数据 |  |

<a id="get-api-monitor-health-health"></a>

### 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 | 否 | 返回数据 |  |

<a id="get-error-handleerror"></a>

### 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 | 否 | 返回数据 |  |

<a id="post-error-handleerror-1"></a>

### 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 | 否 | 返回数据 |  |

<a id="put-error-handleerror-2"></a>

### 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 | 否 | 返回数据 |  |

<a id="delete-error-handleerror-3"></a>

### 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 | 否 | 返回数据 |  |

<a id="patch-error-handleerror-4"></a>

### 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 | 否 | 返回数据 |  |

<a id="options-error-handleerror-6"></a>

### 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 | 否 | 返回数据 |  |

<a id="head-error-handleerror-5"></a>

### 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 | 否 | 返回数据 |  |


## 模型定义

### com.leadwaycloud.manager.business.manager.dto.ChangePasswordDTO

修改密码数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| newPassword | string | 是 | MD5(1qazxsw) |  |
| confirmPassword | string | 是 | 确认密码 | "MD5(1qazxsw)" |

### com.leadwaycloud.core.model.RJava.lang.Boolean

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

### 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 | 否 | 地址 | "四川省成都市" |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.manager.entity.ManagerUser

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

### com.leadwaycloud.manager.business.manager.entity.ManagerUser

用户

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| account | string | 是 | 账号 | "admin" |
| name | string | 是 | 名称 | "管理员" |
| image | string | 否 | 头像 |  |
| status | string | 是 | 状态  【 INACTIVATED : 待激活的   ACTIVE : 活跃的   BLOCK : 锁定的   DELETE : 被删除的   】 | "ACTIVE" |
| userInfo | ManagerUserInfo | 是 |  |  |
| token | string | 否 | 登录接口中会返回 |  |

### com.leadwaycloud.manager.business.manager.entity.ManagerUserInfo

用户信息

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| email | string | 是 | 邮箱 | "demo@leadwaycloud.com" |
| phone | string | 否 | 电话 | "0288888888" |
| mobilePhone | string | 否 | 手机 | "13888888888" |
| address | string | 否 | 地址 | "四川省成都市" |

### com.leadwaycloud.manager.business.manager.dto.ForgetPasswordDTO

忘记密码数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| account | string | 是 | 账号 |  |
| captcha | string | 是 | 验证码 |  |
| newPassword | string | 是 | MD5(1qazxsw) |  |
| confirmPassword | string | 是 | 确认密码 | "MD5(1qazxsw)" |

### com.leadwaycloud.manager.business.manager.dto.ActivationUserDTO

激活用户数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| account | string | 是 | 账号 |  |
| captcha | string | 是 | 验证码 |  |
| newPassword | string | 是 | MD5(1qazxsw) |  |
| confirmPassword | string | 是 | 确认密码 | "MD5(1qazxsw)" |

### com.leadwaycloud.monitor.model.dto.SysVersionDTO$UpdateDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| serviceName | string | 否 |  |  |
| code | string | 否 |  |  |
| deployTime | string(date-time) | 否 |  |  |
| content | string | 否 |  |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.monitor.model.entity.SysVersion

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

### com.leadwaycloud.monitor.model.entity.SysVersion

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| serviceName | string | 否 |  |  |
| code | string | 否 |  |  |
| deployTime | string(date-time) | 否 |  |  |
| content | string | 否 |  |  |

### com.leadwaycloud.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简称 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.uom.entity.SysUom

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

### com.leadwaycloud.manager.business.uom.entity.SysUom

计量单位

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| code | string | 是 | 编号 | "1" |
| name | string | 是 | 名称 | "公斤" |
| symbol | string | 是 | 符号 | "kg" |
| active | boolean | 是 | 是否可用 | true |
| subUom | SysUom | 否 |  |  |
| ratio | number(double) | 否 | 换算率 | 1000 |
| shortName | string | 否 | 简称 |  |
| isoShortName | string | 否 | IOS简称 |  |

### 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)[] | 否 | 模版目标对象 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.printer.template.entity.SysPrinterTemplateConfig

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

### com.leadwaycloud.manager.business.api.bo.OpenAPIRequestParamBO

API请求格式数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| paramName | string | 是 | 参数名称 | "userId" |
| paramDescription | string | 是 | 参数说明 | "用户ID" |
| requestType | string | 是 | 请求类型 | "body" |
| must | boolean | 是 | 是否必须 | true |
| dataType | string | 是 | 数据类型 | "integer" |
| subRequestParam | OpenAPIRequestParamBO[] | 否 | 子级请求参数 |  |

### com.leadwaycloud.manager.business.api.bo.OpenAPIResponseParamBO

API响应格式数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| paramName | string | 是 | 参数名称 | "data.id" |
| paramDescription | string | 是 | 参数说明 | "用户ID" |
| dataType | string | 是 | 数据类型 | "integer" |
| subResponseParam | OpenAPIResponseParamBO[] | 否 | 子级响应参数 |  |

### com.leadwaycloud.manager.business.api.entity.SysApi

系统接口

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| id | integer(int64) | 是 | 数据ID | 1 |
| open | boolean | 是 | 是否是公开的 | false |
| sort | integer(int64) | 是 | 排序 | 1 |
| serviceCode | string | 是 | 服务编号 | "lwc-cloud-erp-manager" |
| name | string | 是 | 功能名称 | "停用账号" |
| path | string | 是 | 接口路径 | "/lwc-cloud-erp-manager/sys/api/user/update-info" |
| method | string | 是 | 请求方式 | "PUT" |
| contentType | string | 是 | 数据类型 | "application/json" |
| description | string | 否 | 接口描述 |  |
| requestDemo | string | 否 | 请求示例 |  |
| requestParam | OpenAPIRequestParamBO[] | 否 | 请求参数 |  |
| responseDemo | string | 是 | 响应示例 |  |
| responseParam | OpenAPIResponseParamBO[] | 是 | 响应参数 |  |

### com.leadwaycloud.manager.business.company.entity.ResSimpleCompany

公司(单条数据查询时返回)

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| code | string | 是 | 公司编号(仅允许字母和数字) | "CD01" |
| otherCode | string | 是 | 其他编号 | "AAAA-01" |
| 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" |
| status | string | 是 | 状态  【 IN_OPERATION : 营业中   TO_BE_OPENED : 待开业   PREPARATION : 筹备中   】 | "IN_OPERATION" |
| name | string | 是 | 名称 |  |
| merchantId | integer(int64) | 是 | 商户ID | 1 |

### com.leadwaycloud.manager.business.currency.entity.SysCurrency

货币

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| code | string | 是 | 编号 | "CNY" |
| name | string | 是 | 名称 | "人民币" |
| symbol | string | 是 | 符号 | "¥" |
| image | string | 否 | 图片 |  |
| rounding | integer(int32) | 是 | 四舍五入精度 | 2 |
| active | boolean | 是 | 是否可用 | true |
| calcRate | boolean | 是 | 是否计算汇率 | true |
| calcRateUnit | number(double) | 否 | 汇率计算单位 | 100 |

### com.leadwaycloud.manager.business.merchant.entity.ResMerchant

商户

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| code | string | 是 | 商户代号 | "lwc" |
| abbreviation | string | 是 | 简称 | "立威云" |
| fullName | string | 是 | 全称 | "成都立威云科技有限公司" |
| status | string | 是 | 状态  【 OPEN : 开放的   CLOSE : 关闭的   】 | "OPEN" |
| industry | string | 是 | 行业  【 COMPLEX : 大型购物中心;多种经营联合体;跨行业经营集团   TRADE : 商贸经营企业   RETAIL : 商超经营企业   RESTAURANT : 餐饮企业   FOOD : 餐饮企业   ENERGY : 加油、气、店站   OIL : 加油、气、店站   CRUISE : 邮轮旅游   PLAYGROUND : 游乐场综合体   MANUFACTURING : 生产制造业   】 | "COMPLEX" |
| email | string | 是 | 联系邮箱(用作初始化创建账号) | "sale@leadwaycloud.com" |
| phone | string | 否 | 联系电话 |  |
| address | string | 否 | 联系地址 |  |
| logo | string | 否 | 图标 |  |
| currency | SysCurrency | 是 |  |  |
| merchantConfig | ResMerchantConfig | 否 |  |  |
| modelList | SysModel[] | 否 | 商户模块 |  |

### com.leadwaycloud.manager.business.merchant.entity.ResMerchantConfig

商户配置

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| expireDate | string | 是 | 过期日期 | "2029-11-30" |
| userCount | integer(int32) | 是 | 用户数量 | 1 |
| posCount | integer(int32) | 是 | 机台数量 | 1 |
| otherConfig | string | 否 | 其他配置(json字符串) | "{}" |

### com.leadwaycloud.manager.business.merchant.entity.ResSimpleMerchant

商户

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| code | string | 是 | 商户代号 | "lwc" |
| abbreviation | string | 是 | 简称 | "立威云" |
| fullName | string | 是 | 全称 | "成都立威云科技有限公司" |
| status | string | 是 | 状态  【 OPEN : 开放的   CLOSE : 关闭的   】 | "OPEN" |
| industry | string | 是 | 行业  【 COMPLEX : 大型购物中心;多种经营联合体;跨行业经营集团   TRADE : 商贸经营企业   RETAIL : 商超经营企业   RESTAURANT : 餐饮企业   FOOD : 餐饮企业   ENERGY : 加油、气、店站   OIL : 加油、气、店站   CRUISE : 邮轮旅游   PLAYGROUND : 游乐场综合体   MANUFACTURING : 生产制造业   】 | "COMPLEX" |

### com.leadwaycloud.manager.business.model.entity.SysModel

系统模块

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| code | string | 是 | 编号 | "HR" |
| name | string | 是 | 名称 | "认识" |
| active | boolean | 是 | 是否可用 | true |
| description | string | 否 | 描述 |  |
| version | string | 是 | 版本编号 |  |
| image | string | 是 | 图片 |  |
| appId | integer(int64) | 否 | sys_app.id |  |

### com.leadwaycloud.manager.business.printer.template.entity.SysPrinterTemplateConfig

系统打印模版配置

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| name | string | 是 | 名称 |  |
| description | string | 否 | 描述 | "公司名称" |
| status | string | 是 | 状态  【 DRAFT : 草稿   VALID : 可用   VOID : 作废   】 | "DRAFT" |
| type | string | 是 | 类型  【 REPORT : 报表   RECEIPT : 单据   LABEL : 标签   】 | "REPORT" |
| sysReport | SysReport | 否 |  |  |
| receiptCode | string | 否 | 单据代号 |  |
| apiId | integer(int64) | 否 | 打印模板对应的数据源API |  |
| configData | string | 是 | 打印模版配置 |  |
| merchant | ResSimpleMerchant | 否 |  |  |
| company | integer(int64)[] | 否 | 公司 |  |
| targetType | string | 否 | 模版目标对象类型  【 SUPPLIER : 供应商   CUSTOMER : 客户   AGENT : 代理商   CARRIER : 承运商   PRODUCER : 生产商   MEMBER : 会员   】 |  |
| targets | integer(int64)[] | 否 | 模版目标对象 |  |
| api | SysApi | 否 |  |  |
| companyList | ResSimpleCompany[] | 否 | 公司(单条数据查询时返回) |  |
| targetList | object[] | 否 | 模版目标对象(单条数据查询时返回) |  |

### com.leadwaycloud.manager.business.report.entity.SysReport

系统报表

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| model | SysModel | 是 |  |  |
| 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" |
| merchant | ResMerchant | 否 |  |  |
| type | string | 是 | 类型  【 EXCEL : 文档   BAR_CHART : 柱状图   PIE_CHART : 饼状图   LINE_CHART : 折线图   OTHER : 其他   】 | "EXCEL" |
| useType | string | 是 | 用途类型  【 DASHBOARD : 仪表盘   REPORT : 报表   DOCUMENT : 单据   】 | "DASHBOARD" |
| active | boolean | 是 | 是否可用 | true |
| description | string | 否 | 描述 |  |

### com.leadwaycloud.manager.business.operational.doc.dto.UpdateCustomMenuOperationalDocDTO

修改自定义菜单操作文档

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| industry | string | 否 | 行业  【 COMPLEX : 大型购物中心;多种经营联合体;跨行业经营集团   TRADE : 商贸经营企业   RETAIL : 商超经营企业   RESTAURANT : 餐饮企业   FOOD : 餐饮企业   ENERGY : 加油、气、店站   OIL : 加油、气、店站   CRUISE : 邮轮旅游   PLAYGROUND : 游乐场综合体   MANUFACTURING : 生产制造业   】 | "COMPLEX" |
| modelId | integer(int64) | 否 | 系统模块ID |  |
| customMenu | string | 否 | 自定义菜单 | "1" |

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

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

### 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 | 否 | 描述 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.report.entity.SysReport

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

### com.leadwaycloud.manager.business.report.dto.UpdateReportViewConfigDTO

修改报表展示配置数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| viewConfig | string | 否 | 报表视图配置 |  |
| apiId | integer(int64) | 否 | 报表获取数据的系统API | 1 |
| apiPath | string | 否 | 系统接口路径 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.report.entity.SysReportViewConfig

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

### com.leadwaycloud.manager.business.report.entity.SysReportViewConfig

系统报表展示配置

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| viewConfig | string | 是 | 报表视图配置 |  |
| apiId | integer(int64) | 否 | 系统API |  |
| apiPath | string | 否 | 系统接口路径 |  |
| api | SysApi | 否 |  |  |

### 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 |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.platform.version.entity.SysPlatformVersion

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

### com.leadwaycloud.manager.business.platform.version.entity.SysPlatformModelVersion

平台版本模块信息

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| platformVersionId | integer(int64) | 是 | 平台版本ID | 1 |
| sysModelId | integer(int64) | 是 | 模块ID | 1 |
| content | string | 是 | 发布内容 |  |
| model | SysModel | 是 |  |  |

### com.leadwaycloud.manager.business.platform.version.entity.SysPlatformVersion

平台版本信息

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| version | string | 是 | 版本 | "1.0.0.1" |
| deployTime | string | 是 | 发布时间 | "2020-10-11 13:09:11" |
| platformModelVersionList | SysPlatformModelVersion[] | 是 | 平台版本模块信息 |  |

### 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 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.model.entity.SysModel

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

### 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 | 否 | 图标 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.merchant.entity.ResMerchant

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

### 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字符串) | "{}" |

### com.leadwaycloud.manager.business.menu.dto.UpdateMenuDTO

修改菜单数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| code | string | 否 | 编号 | "HR" |
| name | string | 否 | 名称 | "认识" |
| active | boolean | 否 | 是否可用 | true |
| description | string | 否 | 描述 |  |
| filter | string | 否 | 根据参数过滤菜单 |  |
| button | string | 否 | 菜单下的按钮json |  |
| image | string | 否 | 图标 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.menu.entity.SysMenu

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

### com.leadwaycloud.manager.business.menu.entity.SysMenu

系统菜单

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| code | string | 是 | 编号 | "HR" |
| name | string | 是 | 名称 | "认识" |
| active | boolean | 是 | 是否可用 | true |
| description | string | 否 | 描述 |  |
| filter | string | 是 | 根据参数过滤菜单 |  |
| button | string | 是 | 菜单下的按钮json |  |
| image | string | 否 | 图标 |  |

### com.leadwaycloud.manager.business.im.msg.template.dto.IMMsgTemplateDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| code | string | 否 | 编号(没提供,后端会以过UUID的方式生成) |  |
| name | string | 是 | 名称 | "会议邀请" |
| config | string | 是 | 模版消息配置 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.im.msg.template.entity.IMMsgTemplate

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

### com.leadwaycloud.manager.business.im.msg.template.entity.IMMsgTemplate

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| code | string | 是 | 唯一键 | "UUID" |
| name | string | 是 | 名称 | "会议邀请" |
| config | string | 是 | 模版消息配置 |  |

### com.leadwaycloud.manager.business.function.bo.FunctionMatchApiBO

匹配的API

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| apiId | integer(int64) | 是 | ID | 1 |
| name | string | 是 | 名称 | "xxx" |
| path | string | 是 | 地址 | "xxx" |

### 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 |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.function.entity.SysFunction

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

### com.leadwaycloud.manager.business.app.entity.SysApp

系统APP

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| name | string | 是 | 名称 | "Slim POS" |
| code | string | 是 | 代号 | "SLIM_POS" |
| image | string | 否 | 图片 |  |
| platformFrameworkList | APPPlatformFrameworkVO | 否 |  |  |

### com.leadwaycloud.manager.business.app.entity.SysAppPackage

系统APP安装包

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| appId | integer(int64) | 是 | APP ID | 1 |
| platform | string | 是 | 平台 | "WINDOWS" |
| framework | string | 否 | 架构 | "x86" |
| version | string | 是 | 版本 | "1.0.0.1" |
| buildVersion | string | 否 | 构建版本 | "20241217001" |
| packageShortCode | string | 是 | 安装包短码 | "2FWD" |
| packageFileName | string | 是 | 安装包文件名称 | "UUID.exe" |
| packageSize | integer(int64) | 是 | 安装包大小 | 1 |
| releaseNote | string | 是 | 版本发布信息 | "xxxx" |
| cold | boolean | 是 | 是否必须冷更新 | true |
| heatPackageShortCode | string | 否 | 热更新包短码 | "2DWD" |
| heatPackageFileName | string | 否 | 热更新包文件名称 | "UUID.exe" |
| heatPackageSize | integer(int64) | 否 | 热更新安装包大小 | 1 |
| sandbox | boolean | 否 | 沙盒 | true |
| active | boolean | 是 | 是否已发布 | true |
| app | SysApp | 是 |  |  |

### com.leadwaycloud.manager.business.app.vo.APPPlatformFrameworkVO

APP支持的平台与架构

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| platform | string | 是 | 平台 | "WINDOWS" |
| framework | string | 否 | 架构 | "x86" |
| lastAppPackage | SysAppPackage | 否 |  |  |

### com.leadwaycloud.manager.business.function.entity.SysFunction

系统功能

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| 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 |
| parentId | integer(int64) | 否 | 上级功能ID | 1 |
| appId | integer(int64) | 否 | sys_app.id |  |
| matchApiList | FunctionMatchApiBO[] | 否 | 匹配的API | 1 |
| app | SysApp | 否 |  |  |
| matchApiStr | string | 否 | 匹配的API | "1" |

### com.leadwaycloud.manager.business.express.dto.UpdateExpressDTO

修改快递公司数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| code | string | 否 | 参数code | "ems" |
| name | string | 否 | 名称 | "EMS快递" |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.express.entity.SysExpress

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

### com.leadwaycloud.manager.business.express.entity.SysExpress

系统快递公司

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| code | string | 是 | 参数code | "ems" |
| name | string | 是 | 名称 | "EMS快递" |

### com.leadwaycloud.manager.business.device.command.bo.DeviceCommandBO

设备指令集数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 否 | 指令名称 | "切纸" |
| code | string | 是 | 指令Code | "PARTIAL_CUT" |
| command | string | 是 | 指令 | "0x1D,0x56,0x00" |
| description | string | 否 | 指令描述 | "用作执行打印切纸动作" |

### 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":"用作执行打印切纸动作"}] |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.device.command.entity.SysDeviceCommand

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

### com.leadwaycloud.manager.business.device.command.entity.SysDeviceCommand

设备指令集

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| brand | string | 是 | 品牌 | "Epson" |
| model | string | 是 | 型号 | "TM-T70" |
| type | string | 是 | 设备类型  【 PRINTER : 打印机   】 | "PRINTER" |
| command | DeviceCommandBO[] | 是 | 指令集 | [{"name":"切纸","code":"PARTIAL_CUT","command":"0x1D,0x56,0x00","description":"用作执行打印切纸动作"}] |

### 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 |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.currency.entity.SysCurrency

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

### 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" |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.company.entity.ResCompany

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

### com.leadwaycloud.manager.business.company.entity.FinanceInvoiceTitle

发票抬头

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| headerName | string | 否 | 抬头名称 | "...." |
| address | string | 否 | 地址 | "...." |
| taxNo | string | 否 | 税号 | "...." |
| phone | string | 否 | 电话 | "...." |
| bank | string | 否 | 开户银行 | "...." |
| bankAccounts | string | 否 | 银行账户 | "...." |
| recipient | string | 否 | 收件人 | "...." |
| mailAddress | string | 否 | 邮寄地址 | "...." |
| receivePhone | string | 否 | 收件人手机或电话 | "...." |
| partnerId | string | 是 | CRM客户关系 | "1" |
| merchantId | string | 是 | 商户ID | "1" |
| billingPeriod | integer(int32) | 否 | 账期 | 1 |

### com.leadwaycloud.manager.business.company.entity.ResCompany

总部/区域总部/公司/门店

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| code | string | 是 | 公司编号(仅允许字母和数字) | "CD01" |
| otherCode | string | 是 | 其他编号 | "AAAA-01" |
| 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" |
| status | string | 是 | 状态  【 IN_OPERATION : 营业中   TO_BE_OPENED : 待开业   PREPARATION : 筹备中   】 | "IN_OPERATION" |
| idChain | string | 是 | 公司ID完整架构(上下级公司id用-连接) | "123-456" |
| slogan | string | 否 | 公司标语 | "努力工作就是为了不工作" |
| initConfig | string | 是 | 公司配置是否初始化 | "false" |
| name | string | 是 | 名称 |  |
| image | string | 否 | 图片 |  |
| contact | ResContact | 是 |  |  |
| partner | ResPartner | 是 |  |  |
| currency | SysCurrency | 否 |  |  |
| financeInvoiceTitle | FinanceInvoiceTitle | 否 |  |  |

### com.leadwaycloud.manager.business.user.entity.ResContact

联系信息

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| countryId | integer(int64) | 否 | 国家ID | 1 |
| stateId | integer(int64) | 否 | 省、直辖市ID | 1 |
| cityId | integer(int64) | 否 | 城市ID | 1 |
| areaId | integer(int64) | 否 | 区、县ID | 1 |
| streetId | integer(int64) | 否 | 街道ID | 1 |
| address | string | 否 | 详细地址 | "1" |
| postcode | string | 否 | 邮编 | "1" |
| phone | string | 否 | 电话 | "1" |
| mobile | string | 否 | 手机 | "1" |
| fax | string | 否 | 传真 | "1" |
| email | string | 否 | 邮箱 | "邮箱" |
| latLon | string | 否 | 经纬度(纬度,经度) | "104.064737,30.547256" |

### com.leadwaycloud.manager.business.user.entity.ResPartner

会员/供应商/客户/员工/加盟商/公司/用户数据关联

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| member | boolean | 是 | 是否是会员 | false |
| supplier | boolean | 是 | 是否是供应商 | false |
| customer | boolean | 是 | 是否是客户 | false |
| employee | boolean | 是 | 是否是员工 | false |
| franchisee | boolean | 是 | 是否是加盟商 | false |
| company | boolean | 是 | 是否是公司 | false |
| user | boolean | 是 | 是否是用户 | false |
| carrier | boolean | 是 | 是否是承运商 | false |
| agent | boolean | 是 | 是否是代理 | false |
| extensionInfo | string | 否 | 扩展信息 |  |

### 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 |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.application.entity.SysApplication

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

### com.leadwaycloud.manager.business.application.entity.SysApplication

系统应用

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| 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 |

### com.leadwaycloud.manager.business.app.dto.UpdateAppDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 否 | 名称 | "Slim POS" |
| image | string | 否 | 照片 | "xxx" |

### com.leadwaycloud.manager.business.app.dto.UploadAppPackageDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| releaseNote | string | 是 | 版本发布信息 | "xxxx" |

### com.leadwaycloud.manager.business.address.dto.UpgradeAddressDTO

升级五级联动地址数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 是 | 名称 | "中国" |
| countryCode | string | 是 | 国际代码 | "CN" |
| language | string | 是 | 语言 | "zh_CN" |
| updateYear | integer(int32) | 是 | 更新年度 | 2020 |

### 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 |

### com.leadwaycloud.manager.business.accounting.dto.UpdateAccountingTypeDTO

修改会计科目类别数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| code | string | 否 | 编号(纯数字) | "1000" |
| name | string | 否 | 名称 | "资产类" |
| enName | string | 否 | 英文名称 | "Assets" |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.accounting.entity.SysAccountingType

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

### com.leadwaycloud.manager.business.accounting.entity.SysAccountingType

会计科目类别

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| code | string | 是 | 编号(纯数字) | "1000" |
| name | string | 是 | 名称 | "资产类" |
| enName | string | 否 | 英文名称 | "Assets" |

### 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 |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.accounting.entity.SysAccountingTitle

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

### com.leadwaycloud.manager.business.accounting.entity.SysAccountingTitle

会计科目

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| accountingType | SysAccountingType | 是 |  |  |
| code | string | 是 | 编号 | "1001" |
| name | string | 是 | 名称 | "库存现金" |
| enName | string | 否 | 英文名称 | "Cash" |
| scope | string | 否 | 会计科目使用范围 |  |
| allowBillUpdateAmount | boolean | 是 | 是否允许在收/付款单中修改金额 | true |

### com.leadwaycloud.manager.business.property.dto.SysPropertyDTO$AddDTO

添加属性DTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 是 | 名称 |  |
| group | string | 是 | 分组 |  |
| val | string | 是 | 属性值 |  |
| description | string | 否 | 描述 |  |
| parentId | integer(int64) | 否 | 上一级 |  |
| sequence | integer(int32) | 否 | 排序 |  |
| hide | boolean | 否 | 是否隐藏 |  |
| merchantId | integer(int64) | 否 | 商户ID |  |
| active | boolean | 否 | 状态 |  |
| id | integer(int64) | 否 | id |  |

### com.leadwaycloud.manager.business.property.dto.SysPropertyDTO$UpdateDTO

编辑属性DTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| updateList | SysPropertyDTO$AddDTO[] | 否 | 编辑数据集合 |  |
| deleteIdList | integer(int64)[] | 否 | 要删除的属性ID集合 |  |

### 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 | 否 | 地址 | "四川省成都市" |

### com.leadwaycloud.manager.business.manager.dto.LoginDTO

登录数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| account | string | 是 | 账号 | "admin" |
| password | string | 是 | 密码 | "MD5(1qazxsw)" |

### com.leadwaycloud.core.model.RJava.lang.String

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

### com.leadwaycloud.manager.business.manager.dto.UploadFileDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| host | string | 是 | 远程主机地址 |  |
| port | integer(int32) | 是 | SSH端口号 |  |
| username | string | 是 | 登录用户名 |  |
| password | string | 是 | 登录密码 |  |
| connectionTimeout | integer(int32) | 是 | 连接超时时间(毫秒) |  |
| executeTimeout | integer(int32) | 是 | 执行超时时间(毫秒) |  |
| serviceDirectoryPath | string | 是 | 服务器文件目录 |  |

### 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[] | 是 | 命令集 |  |

### com.leadwaycloud.core.model.RJava.util.ListJava.lang.String

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

### com.leadwaycloud.monitor.model.dto.SysVersionDTO$AddDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| serviceName | string | 否 |  |  |
| code | string | 否 |  |  |
| deployTime | string(date-time) | 否 |  |  |
| content | string | 否 |  |  |

### 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简称 |  |

### 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)[] | 否 | 模版目标对象 |  |

### 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)[] | 否 | 模版目标对象 |  |

### 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)[] | 否 | 模版目标对象 |  |

### com.leadwaycloud.manager.business.operational.doc.dto.AddCustomMenuOperationalDocDTO

添加自定义菜单操作文档

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| industry | string | 是 | 行业  【 COMPLEX : 大型购物中心;多种经营联合体;跨行业经营集团   TRADE : 商贸经营企业   RETAIL : 商超经营企业   RESTAURANT : 餐饮企业   FOOD : 餐饮企业   ENERGY : 加油、气、店站   OIL : 加油、气、店站   CRUISE : 邮轮旅游   PLAYGROUND : 游乐场综合体   MANUFACTURING : 生产制造业   】 | "COMPLEX" |
| modelId | integer(int64) | 是 | 系统模块ID |  |
| customMenu | string | 是 | 自定义菜单 | "1" |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.imp.template.entity.SysImportTemplate

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

### com.leadwaycloud.manager.business.imp.template.entity.SysImportTemplate

系统导入模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| type | string | 是 | 导入模板类型 |  |
| fileId | string | 是 | 文件服务器文件ID |  |
| version | string | 否 | 版本 |  |

### 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 | 否 | 参数描述 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.setting.entity.SysSetting

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

### com.leadwaycloud.manager.business.setting.entity.SysSetting

系统参数公共配置

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| scope | string | 是 | 参数作用域  【 MERCHANT : 商户   COMPANY : 公司   】 | "MERCHANT" |
| scopeValue | string | 是 | scope=MERCHANT 则为商户行业 scope=COMPANY 则为公司类型 | "COMPLEX" |
| type | string | 是 | 参数设置类型  【 GLOBAL : 全局   MODEL : 模块   】 | "GLOBAL" |
| typeValue | string | 是 | 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 | 否 | 参数描述 |  |

### com.leadwaycloud.manager.business.sensitive.word.dto.AddSensitiveWordDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| model | string | 是 | 模式(可能会有各个模块不同类型的,所以此处预留了类型栏位。消息服务就使用模块名称:message) | "message" |
| txt | string | 是 | 文本 | "你好" |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.role.entity.ResRole

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

### com.leadwaycloud.manager.business.role.entity.ResRole

角色

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| name | string | 是 | 名称 | "系统管理" |
| description | string | 是 | 描述 |  |
| system | string | 否 | 是否是系统默认分组(系统默认角色(不可修改/删除)) | "false" |
| companyType | string | 否 | 公司类型 |  |

### 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 | 否 | 描述 |  |

### com.leadwaycloud.manager.business.report.dto.AddReportViewConfigDTO

添加报表展示配置数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| viewConfig | string | 是 | 报表视图配置 |  |
| apiId | integer(int64) | 否 | 报表获取数据的系统API | 1 |
| apiPath | string | 否 | 系统接口路径 |  |

### com.leadwaycloud.manager.business.model.dto.AddModelDTO

添加模块数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| code | string | 是 | 编号 | "HR" |
| name | string | 是 | 名称 | "认识" |
| description | string | 否 | 描述 |  |
| version | string | 是 | 版本编号 |  |
| image | string | 是 | 图片 |  |
| appId | integer(int64) | 否 | sys_app.id |  |

### 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字符串) | "{}" |

### com.leadwaycloud.manager.business.merchant.dto.AddInitMerchantForSqlDTO

添加初始化商户(Sql)数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| 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 | 否 | 描述 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.merchant.entity.SysInitMerchant

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

### com.leadwaycloud.manager.business.merchant.entity.SysInitMerchant

系统初始化商户数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| merchantIndustry | string | 是 | 商户行业  【 COMPLEX : 大型购物中心;多种经营联合体;跨行业经营集团   TRADE : 商贸经营企业   RETAIL : 商超经营企业   RESTAURANT : 餐饮企业   FOOD : 餐饮企业   ENERGY : 加油、气、店站   OIL : 加油、气、店站   CRUISE : 邮轮旅游   PLAYGROUND : 游乐场综合体   MANUFACTURING : 生产制造业   】 | "COMPLEX" |
| index | integer(int32) | 是 | 初始化顺序 | 1 |
| type | string | 是 | 初始化类型  【 ENTITY : 实体类   SQL : sql语句   INTERFACE : 请求接口   】 | "ENTITY" |
| format | string | 是 | 规格 |  |
| data | string | 是 | 数据 | "{}" |
| description | string | 否 | 描述 |  |

### com.leadwaycloud.manager.business.company.dto.SysInitHttpDTO

商户系统初始化对外http请求数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| method | string | 是 | 请求方式 | "PUT" |
| contentType | string | 是 | 数据类型 | "application/json" |
| connectionTimeout | integer(int32) | 是 | 连接超时时间(毫秒) | 1000 |
| readTimeout | integer(int32) | 是 | 数据读取超时时间(毫秒) | 2000 |
| requestParamMap | object | 是 | 请求数据 | {"companyId":1} |

### 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 | 否 | 描述 |  |

### 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 | 否 | 描述 |  |

### com.leadwaycloud.manager.business.menu.dto.AddMenuDTO

添加菜单数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| code | string | 是 | 编号 | "HR" |
| name | string | 是 | 名称 | "认识" |
| description | string | 否 | 描述 |  |
| filter | string | 是 | 根据参数过滤菜单 |  |
| button | string | 是 | 菜单下的按钮json |  |
| image | string | 否 | 图标 |  |

### com.leadwaycloud.manager.business.i18n.dto.TranslationDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| langId | integer(int64) | 是 | 语言ID | 1 |
| industry | string | 是 | 商户类型 |  |
| translationValue | object | 是 | 字典(map三级嵌套：application->module->key:value) | {"crm":{"common":{"K19419c77":"商品名称"}}} |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.i18n.entity.ResLang

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

### com.leadwaycloud.manager.business.i18n.entity.ResLang

多语言参数

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| name | string | 是 | 名称 |  |
| code | string | 是 | 语言编码 | "zh_CN" |
| direction | string | 是 | 排序方向 | "ltr" |
| thousandsSep | string | 否 | 千分位符号 |  |
| translatable | boolean | 否 | 是否有翻译 | false |
| dateFormat | string | 是 | 日期格式 | "%Y年%m月%d日" |
| timeFormat | string | 是 | 时间格式 | "%H时%M分%S秒" |
| decimalPoint | string | 是 | 小数点符号 | "." |
| active | boolean | 是 | 是否可用 | true |
| isoCode | string | 否 | 国际标准编码符号 | "zh_CN" |
| weekStart | integer(int32) | 是 | 每周开始天 | 7 |

### 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 |

### 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 |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.function.entity.SysFunctionTemplate

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

### com.leadwaycloud.manager.business.function.entity.SysFunctionTemplate

系统功能模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| 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" |
| function | SysFunction | 是 |  |  |

### 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] |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.function.entity.SysFunctionTemplate

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

### 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] |

### com.leadwaycloud.manager.business.express.dto.AddExpressDTO

添加快递公司数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| code | string | 是 | 参数code | "ems" |
| name | string | 是 | 名称 | "EMS快递" |

### 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":"用作执行打印切纸动作"}] |

### 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 |

### 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" |

### com.leadwaycloud.manager.business.company.dto.AddContactDTO

添加联系地址

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

### com.leadwaycloud.manager.business.company.dto.AddFinanceInvoiceTitleDTO

添加发票抬头信息

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| headerName | string | 否 | 抬头名称 | "...." |
| address | string | 否 | 地址 | "...." |
| taxNo | string | 否 | 税号 | "...." |
| phone | string | 否 | 电话 | "...." |
| bank | string | 否 | 开户银行 | "...." |
| bankAccounts | string | 否 | 银行账户 | "...." |
| recipient | string | 否 | 收件人 | "...." |
| mailAddress | string | 否 | 邮寄地址 | "...." |
| receivePhone | string | 否 | 收件人手机或电话 | "...." |
| partnerId | string | 否 | CRM客户关系 | "1" |
| merchantId | string | 否 | 商户ID | "1" |
| billingPeriod | integer(int32) | 否 | 账期 | 1 |

### com.leadwaycloud.manager.business.company.dto.AddInitCompanyForSqlDTO

添加初始化公司(Sql)数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| 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 | 否 | 描述 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.company.entity.SysInitCompany

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

### com.leadwaycloud.manager.business.company.entity.SysInitCompany

系统初始化公司数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| 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 |
| type | string | 是 | 初始化类型 | "com.leadwaycloud.manager.common.enums.SysInitEnum" |
| format | string | 是 | 规格 |  |
| data | string | 是 | 数据 | "{}" |
| description | string | 否 | 描述 |  |

### 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 | 否 | 描述 |  |

### 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 | 否 | 描述 |  |

### 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 | 否 | 描述 |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.api.entity.SysApi

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

### 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 | 否 | 返回数据 |  |

### com.leadwaycloud.manager.business.address.vo.IpAddressVO

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| country | string | 否 | 国家 | "中国" |
| prov | string | 否 | 省 | "北京市" |
| city | string | 否 | 市 | "北京市" |
| isp | string | 否 | 服务商 | "中国电信" |

### 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 |

### com.leadwaycloud.manager.business.accounting.dto.AddAccountingTypeDTO

添加会计科目类别数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| code | string | 是 | 编号(纯数字) | "1000" |
| name | string | 是 | 名称 | "资产类" |
| enName | string | 否 | 英文名称 | "Assets" |

### 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 |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.property.entity.SysProperty

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

### com.leadwaycloud.manager.business.property.entity.SysProperty

系统公用属性模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| name | string | 是 | 名称 |  |
| group | string | 是 | 分组 |  |
| active | boolean | 是 | 是否可用 |  |
| val | string | 是 | 属性值 |  |
| description | string | 否 | 描述 |  |
| parentId | integer(int64) | 否 | 上一级 |  |
| sequence | integer(int32) | 是 | 排序 |  |
| hide | boolean | 是 | 是否隐藏 |  |
| merchantId | integer(int64) | 否 | 商户ID（系统属性默认为1, 商户属性为对应商户ID） |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.manager.entity.ManagerUser

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.monitor.model.entity.SysVersion

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | SysVersion[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.monitor.model.entity.SysVersion

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

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.monitor.model.entity.SysVersion

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

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.user.entity.ResUser

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

### com.leadwaycloud.manager.business.user.entity.ResUser

用户

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| userName | string | 是 | 账号 | "sale@leadwaycloud.com" |
| name | string | 是 | 名称 | "管理员" |
| status | string | 是 | 状态  【 INACTIVATED : 待激活的   ACTIVE : 活跃的   BLOCK : 锁定的   DELETE : 被删除的   】 | "ACTIVE" |
| language | string | 是 | 语言 | "zh_CN" |
| readVersionInfo | string | 是 | 是否已读更新版本信息 | "false" |
| image | string | 否 | 图片 |  |
| contact | ResContact | 是 |  |  |
| partner | ResPartner | 是 |  |  |
| company | ResCompany | 是 |  |  |
| merchant | ResMerchant | 是 |  |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.user.entity.ResUser

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | ResUser[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.user.entity.ResUser

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

### com.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.uom.entity.SysUom

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | SysUom[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.uom.entity.SysUom

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

### com.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.printer.template.vo.TargetVO

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### com.leadwaycloud.manager.business.printer.template.vo.TargetVO

添加标签打印模版配置数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID | 1 |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| code | string | 是 | 编号 | "1" |
| name | string | 是 | 名称 |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.printer.template.entity.SysPrinterTemplateConfig

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.operational.doc.entity.SysOperationalDoc

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

### com.leadwaycloud.manager.business.operational.doc.entity.SysOperationalDoc

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| industry | string | 是 | 行业  【 COMPLEX : 大型购物中心;多种经营联合体;跨行业经营集团   TRADE : 商贸经营企业   RETAIL : 商超经营企业   RESTAURANT : 餐饮企业   FOOD : 餐饮企业   ENERGY : 加油、气、店站   OIL : 加油、气、店站   CRUISE : 邮轮旅游   PLAYGROUND : 游乐场综合体   MANUFACTURING : 生产制造业   】 | "COMPLEX" |
| modelId | integer(int64) | 是 | 系统模块ID |  |
| menuId | integer(int64) | 是 | 系统菜单ID |  |
| customMenu | string | 否 | 自定义菜单 | "xxxxx" |
| detailList | SysOperationalDocDetail[] | 否 | 操作文档文件 |  |
| model | SysModel | 是 |  |  |
| menu | SysMenu | 是 |  |  |

### com.leadwaycloud.manager.business.operational.doc.entity.SysOperationalDocDetail

操作文档文件

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| operationalDocId | integer(int64) | 是 | 系统操作文档ID |  |
| lang | ResLang | 是 |  |  |
| fileName | string | 是 | 文件名称 |  |
| fileType | string | 是 | 文件类型 |  |
| fileId | string | 是 | 文件服务器上的文件ID |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.operational.doc.entity.SysOperationalDoc

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | SysOperationalDoc[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.operational.doc.entity.SysOperationalDoc

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

### 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[] | 否 | 返回数据 |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.setting.entity.SysSetting

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### 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 | 否 |  |  |

### com.leadwaycloud.manager.business.sensitive.word.entity.SysSensitiveWord

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| model | string | 是 | 模式(可能会有各个模块不同类型的,所以此处预留了类型栏位。消息服务就使用模块名称:message) | "message" |
| type | integer(int32) | 是 | 类型 1:白名单 0:黑名单 | 1 |
| txt | string | 是 | 文本 | "你好" |

### 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.PCom.leadwaycloud.manager.business.role.entity.ResRole

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | ResRole[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.role.entity.ResRole

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

### com.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.function.entity.SysFunction

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.user.entity.ResUser

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

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.function.entity.SysFunction

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

### com.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.report.entity.SysReport

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | SysReport[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.report.entity.SysReport

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

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.platform.version.entity.SysPlatformVersion

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

### com.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.platform.version.entity.SysPlatformVersion

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | SysPlatformVersion[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.platform.version.entity.SysPlatformVersion

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

### com.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.platform.version.vo.SysPlatformModelVersionVO

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | SysPlatformModelVersionVO[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.platform.version.vo.SysPlatformModelVersionVO

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

### com.leadwaycloud.manager.business.platform.version.vo.SysPlatformModelVersionVO

当前页数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| modelId | integer(int64) | 是 | 模块ID | 1 |
| modelCode | string | 是 | 模块编号 | "system" |
| modelName | string | 是 | 模块名称 | "系统设置" |
| version | string | 是 | 版本 | "1" |
| content | string | 是 | 发布类容 |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.platform.version.vo.SysVersionVO

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

### com.leadwaycloud.manager.business.platform.version.vo.SysVersionVO

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 是 | 名称 |  |
| code | string | 是 | 代号 |  |
| version | string | 是 | 版本 |  |
| deployTime | string | 否 | 发布时间 | "2020-10-11 13:09:11" |
| content | string | 否 | 发布内容 |  |

### com.leadwaycloud.manager.business.model.dto.QueryModelDTO

查询模块数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| code | string | 否 | 编号 | "HR" |
| name | string | 否 | 名称 | "认识" |
| active | boolean | 否 | 是否可用 | true |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.model.entity.SysModel

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

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.merchant.entity.ResMerchantInit

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

### com.leadwaycloud.manager.business.merchant.entity.ResMerchantInit

商户初始信息

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| createBy | integer(int64) | 否 |  |  |
| createTime | string(date-time) | 否 |  |  |
| updateBy | integer(int64) | 否 |  |  |
| updateTime | string(date-time) | 否 |  |  |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| index | integer(int32) | 是 | 初始化顺序 | 1 |
| initMerchant | SysInitMerchant | 是 |  |  |
| finish | boolean | 是 | 是否初始化完成 | false |

### com.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.merchant.entity.ResMerchant

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.merchant.entity.SysInitMerchant

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

### com.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.menu.entity.SysMenu

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | SysMenu[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.menu.entity.SysMenu

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

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.menu.entity.SysMenu

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

### com.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.merchant.entity.ImpMerchantInitData

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### com.leadwaycloud.manager.business.merchant.entity.ImpMerchantInitData

导入的商户初始数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| merchantId | integer(int64) | 是 | 商户ID(导入数据的商户ID) | 1 |
| dataType | string | 是 | 导入数据类型  【 COMPANY : 门店信息   ACCOUNT : 会计科目   TAX : 税   USER : 登录账号   TENDER : 支付方式   OIL_TANK : 油站油罐   GOODS : 商品   SUPPLIER : 供应商   GOODS_MOVING_AVERAGE_PRICE : 商品移动平均价格   】 | "USER" |
| data | string | 是 | 导入的数据 |  |
| impTime | string | 否 | 导入的时间 | "2020-10-11 13:09:11" |
| finishTime | string | 否 | 完成的时间 | "2020-10-11 13:09:11" |
| process | boolean | 否 | 是否有进行过处理 | false |
| success | boolean | 否 | 是否处理成功 | false |
| msg | string | 否 | 处理结果 | "成功" |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.merchant.vo.SupportImpDataTypeVO

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

### com.leadwaycloud.manager.business.merchant.vo.SupportImpDataTypeVO

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 是 | 数据类型名称 | "门店信息" |
| type | string | 是 | 数据类型 | "COMPANY" |
| impIndex | integer(int32) | 是 | 导入顺序(按照顺序导入) | 1 |
| mustImp | boolean | 是 | 是否必须导入(如果是必须导入,则当前数据类型必须导入成功后才开放其他类型数据导入.如果不是必须的则后续的数据类型可部分先后进行导入) | true |
| moreImp | boolean | 是 | 是否允许多次导入(开放支持多次导入则可,多次提交数据。但是不代表可以导入重复数据) | true |

### com.leadwaycloud.core.model.RJava.util.MapJava.lang.StringJava.lang.Boolean

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

### com.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.im.msg.template.entity.IMMsgTemplate

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.i18n.dto.TranslationDTO

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

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.function.vo.SysFunctionVO

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

### com.leadwaycloud.manager.business.function.vo.SysFunctionVO

系统功能(页面)

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID | 1 |
| name | string | 是 | 名称 |  |
| webMenuLevel | integer(int32) | 是 | 页面菜单级别 | 1 |
| webType | string | 是 | 页面类型 |  |
| webRouter | string | 是 | 页面路由 |  |
| index | integer(int32) | 是 | 页面渲染顺序 | 1 |
| description | string | 否 | 描述 |  |
| buttonType | string | 否 | 按钮类型 |  |
| model | SysModel | 是 |  |  |
| menu | SysMenu | 是 |  |  |
| parentFunction | SysFunction | 否 |  |  |
| app | SysApp | 否 |  |  |
| matchApiList | FunctionMatchApiBO[] | 否 | 匹配的API | 1 |
| createBy | integer(int64) | 否 | 创建人ID | 1 |
| createTime | string | 否 | 创建时间 | "2020-10-11 13:09:11" |
| updateBy | integer(int64) | 否 | 修改人ID | 1 |
| updateTime | string | 否 | 修改时间 | "2020-10-11 13:09:11" |

### 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 | 否 |  |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.device.command.entity.SysDeviceCommand

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.currency.entity.SysCurrencyRate

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

### com.leadwaycloud.manager.business.currency.entity.SysCurrencyRate

货币汇率

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| formCurrency | SysCurrency | 是 |  |  |
| toCurrency | SysCurrency | 是 |  |  |
| formAmount | string | 是 | 源金额 | "100" |
| toAmount | number(double) | 是 | 兑换金额 | 100 |
| rate | number(double) | 是 | 汇率 | 1 |
| exchangeDate | string | 是 | 兑换时间 | "2020-10-11" |

### com.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.currency.entity.SysCurrency

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | SysCurrency[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.currency.entity.SysCurrency

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

### com.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.currency.entity.SysCurrencyRate

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | SysCurrencyRate[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.currency.entity.SysCurrencyRate

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

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.company.entity.ResCompanyInit

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

### com.leadwaycloud.manager.business.company.entity.ResCompanyInit

公司初始信息

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| index | integer(int32) | 是 | 初始化顺序 | 1 |
| initCompany | SysInitCompany | 是 |  |  |
| finish | boolean | 是 | 是否初始化完成 | false |

### com.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.company.entity.ResCompany

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.company.entity.ResCompany

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

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.company.entity.SysInitCompany

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

### com.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.application.entity.SysApplication

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.api.entity.SysApi

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | SysApi[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.api.entity.SysApi

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

### com.leadwaycloud.core.model.RJava.util.ListJava.lang.Long

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

### com.leadwaycloud.manager.business.app.dto.QueryAppDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 否 | 名称 | "Slim POS" |
| code | string | 否 | 代号 | "SLIM_POS" |
| platform | string | 否 | 平台 | "WINDOWS" |
| framework | string | 否 | 架构 | "x86" |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.app.entity.SysApp

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

### com.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.app.entity.SysAppPackage

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.app.vo.APPPlatformFrameworkVO

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

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.app.entity.SysAppPackage

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

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.api.entity.SysApi

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

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.api.dto.ServiceDTO

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

### com.leadwaycloud.manager.business.api.dto.ServiceDTO

服务数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| code | string | 是 | 编号 | "LWC_CLOUD_ERP_SYSTEM" |
| name | string | 是 | 名称 | "名称" |

### com.leadwaycloud.manager.business.api.dto.QueryApiDTO

查询API数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| open | boolean | 否 | 是否是公共的 | false |
| serviceCode | string | 否 | 服务编号 | "lwc-cloud-erp-manager" |
| name | string | 否 | 名称 | "停用账号" |
| path | string | 否 | 接口路径 | "/lwc-cloud-erp-manager/sys/api/user/update-info" |
| method | string | 否 | 请求方式 | "PUT" |
| description | string | 否 | 接口描述 |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.address.vo.AddressVO

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

### com.leadwaycloud.manager.business.address.vo.AddressVO

五级联动数据数据模版

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID | 1 |
| code | string | 是 | 代号 |  |
| name | string | 是 | 名称 | "东城区" |
| customize | boolean | 否 | 自定义 | false |
| language | string | 否 | 语言 | "zh_CN" |

### com.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.accounting.entity.SysAccountingTitle

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | 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 | 否 |  |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.manager.business.accounting.entity.SysAccountingType

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

### com.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.property.entity.SysProperty

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | SysProperty[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.manager.business.property.entity.SysProperty

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

### com.leadwaycloud.core.model.RCom.leadwaycloud.manager.business.property.entity.SysProperty

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

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

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

### com.leadwaycloud.core.model.R

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

