2967 lines
50 KiB
Markdown
2967 lines
50 KiB
Markdown
# ERP系统接口API文档
|
||
|
||
## 文档信息
|
||
|
||
| 项目 | 内容 |
|
||
|------|------|
|
||
| 版本号 | 3.4.0 |
|
||
| Base URL | `https://demo.rsun.vip/prod-api` |
|
||
| 文档生成日期 | 2026-01-25 |
|
||
| 数据来源 | Swagger 2.0 API文档 |
|
||
---
|
||
|
||
## 目录
|
||
|
||
1. [概述](#概述)
|
||
2. [通用说明](#通用说明)
|
||
3. [仓库模块](#仓库模块)
|
||
4. [销售模块](#销售模块)
|
||
5. [计划模块](#计划模块)
|
||
6. [采购模块](#采购模块)
|
||
7. [生产模块](#生产模块)
|
||
8. [物料模块](#物料模块)
|
||
9. [研发模块](#研发模块)
|
||
10. [委外模块](#委外模块)
|
||
11. [财务模块](#财务模块)
|
||
12. [数据模型定义](#数据模型定义)
|
||
|
||
---
|
||
|
||
## 概述
|
||
|
||
本文档描述了ERP系统的RESTful API接口，涵盖9个核心业务模块：
|
||
|
||
- **仓库模块**: 库存管理、出入库操作、盘点等
|
||
- **销售模块**: 销售订单、发货、退货、客户管理等
|
||
- **计划模块**: 生产计划、物料需求计划等
|
||
- **采购模块**: 采购订单、到货、发票等
|
||
- **生产模块**: 工单管理、生产执行等
|
||
- **物料模块**: 物料主数据、BOM管理等
|
||
- **研发模块**: 研发BOM、样品配方等
|
||
- **委外模块**: 委外订单、委外加工等
|
||
- **财务模块**: 应收应付、凭证、成本核算等
|
||
|
||
---
|
||
|
||
## 模块swagger api文档地址
|
||
|
||
- https://demo.rsun.vip/prod-api/v2/api-docs?group=计划模块
|
||
描述：本系统包含销售、研发BOM、采购、生产计划、车间、仓库、应收应收付等模块…
|
||
- https://demo.rsun.vip/prod-api/v2/api-docs?group=系统模块
|
||
描述：本系统包含销售、研发BOM、采购、生产计划、车间、仓库、应收应收付等模块…
|
||
- https://demo.rsun.vip/prod-api/v2/api-docs?group=销售模块
|
||
描述：本系统包含销售、研发BOM、采购、生产计划、车间、仓库、应收应收付等模块…
|
||
- https://demo.rsun.vip/prod-api/v2/api-docs?group=采购模块
|
||
描述：本系统包含销售、研发BOM、采购、生产计划、车间、仓库、应收应收付等模块…
|
||
- https://demo.rsun.vip/prod-api/v2/api-docs?group=研发模块
|
||
描述：本系统包含销售、研发BOM、采购、生产计划、车间、仓库、应收应收付等模块…
|
||
- https://demo.rsun.vip/prod-api/v2/api-docs?group=生产模块
|
||
描述：本系统包含销售、研发BOM、采购、生产计划、车间、仓库、应收应收付等模块…
|
||
- https://demo.rsun.vip/prod-api/v2/api-docs?group=物料模块
|
||
描述：本系统包含销售、研发BOM、采购、生产计划、车间、仓库、应收应收付等模块…
|
||
- https://demo.rsun.vip/prod-api/v2/api-docs?group=仓库模块
|
||
描述：本系统包含销售、研发BOM、采购、生产计划、车间、仓库、应收应收付等模块…
|
||
|
||
|
||
## 通用说明
|
||
|
||
### 请求格式
|
||
|
||
- **Content-Type**: `application/json`
|
||
- **字符编码**: UTF-8
|
||
|
||
### 响应格式
|
||
|
||
所有接口返回统一的JSON格式：
|
||
|
||
```json
|
||
{
|
||
"code": 200,
|
||
"msg": "操作成功",
|
||
"data": {}
|
||
}
|
||
```
|
||
|
||
### 分页响应格式
|
||
|
||
列表查询接口返回分页数据：
|
||
|
||
```json
|
||
{
|
||
"total": 100,
|
||
"rows": [],
|
||
"code": 200,
|
||
"msg": "查询成功"
|
||
}
|
||
```
|
||
|
||
### HTTP方法说明
|
||
|
||
| 方法 | 说明 |
|
||
|------|------|
|
||
| GET | 查询数据 |
|
||
| POST | 新增数据 |
|
||
| PUT | 修改数据 |
|
||
| DELETE | 删除数据 |
|
||
|
||
### 通用请求参数
|
||
|
||
| 参数名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| pageNum | integer | 页码，默认1 |
|
||
| pageSize | integer | 每页记录数，默认10 |
|
||
|
||
---
|
||
|
||
## 仓库模块
|
||
|
||
### 模块说明
|
||
|
||
仓库模块提供库存管理相关功能，包括入库、出库、盘点、调拨等操作。
|
||
|
||
### 功能分类
|
||
|
||
| 标签 | 说明 |
|
||
|------|------|
|
||
| 入库单 | 物料入库管理 |
|
||
| 出库单 | 物料出库管理 |
|
||
| 盘点单 | 库存盘点管理 |
|
||
| 仓库 | 仓库基础数据 |
|
||
| 库区 | 库区管理 |
|
||
| 库位 | 库位管理 |
|
||
| 库存查询 | 库存信息查询 |
|
||
| 调拨单 | 库存调拨管理 |
|
||
|
||
### 接口列表
|
||
|
||
#### 入库单接口
|
||
|
||
##### 查询入库单列表
|
||
|
||
```
|
||
GET /wm/itemrecpt
|
||
```
|
||
|
||
**请求参数**
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
|--------|------|------|------|
|
||
| recptCode | string | 否 | 入库单编号 |
|
||
| recptName | string | 否 | 入库单名称 |
|
||
| sourceDocType | string | 否 | 来源单据类型 |
|
||
| status | string | 否 | 状态 |
|
||
|
||
**响应示例**
|
||
|
||
```json
|
||
{
|
||
"total": 10,
|
||
"rows": [
|
||
{
|
||
"recptId": 1,
|
||
"recptCode": "RK202601001",
|
||
"recptName": "原材料入库",
|
||
"sourceDocType": "PO",
|
||
"vendorId": 100,
|
||
"vendorCode": "V001",
|
||
"vendorName": "供应商A",
|
||
"warehouseId": 1,
|
||
"warehouseCode": "WH01",
|
||
"warehouseName": "主仓库",
|
||
"recptDate": "2026-01-25",
|
||
"status": "APPROVED"
|
||
}
|
||
],
|
||
"code": 200,
|
||
"msg": "查询成功"
|
||
}
|
||
```
|
||
|
||
##### 新增入库单
|
||
|
||
```
|
||
POST /wm/itemrecpt
|
||
```
|
||
|
||
**请求体**
|
||
|
||
```json
|
||
{
|
||
"recptName": "原材料入库",
|
||
"sourceDocType": "PO",
|
||
"vendorId": 100,
|
||
"warehouseId": 1,
|
||
"recptDate": "2026-01-25",
|
||
"remark": "备注"
|
||
}
|
||
```
|
||
|
||
##### 修改入库单
|
||
|
||
```
|
||
PUT /wm/itemrecpt
|
||
```
|
||
|
||
**请求体**
|
||
|
||
```json
|
||
{
|
||
"recptId": 1,
|
||
"recptName": "原材料入库-修改",
|
||
"status": "DRAFT"
|
||
}
|
||
```
|
||
|
||
##### 删除入库单
|
||
|
||
```
|
||
DELETE /wm/itemrecpt/{recptIds}
|
||
```
|
||
|
||
**路径参数**
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
|--------|------|------|------|
|
||
| recptIds | string | 是 | 入库单ID，多个用逗号分隔 |
|
||
|
||
##### 获取入库单详情
|
||
|
||
```
|
||
GET /wm/itemrecpt/{recptId}
|
||
```
|
||
|
||
#### 出库单接口
|
||
|
||
##### 查询出库单列表
|
||
|
||
```
|
||
GET /wm/issue
|
||
```
|
||
|
||
**请求参数**
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
|--------|------|------|------|
|
||
| issueCode | string | 否 | 出库单编号 |
|
||
| issueName | string | 否 | 出库单名称 |
|
||
| sourceDocType | string | 否 | 来源单据类型 |
|
||
| status | string | 否 | 状态 |
|
||
|
||
##### 新增出库单
|
||
|
||
```
|
||
POST /wm/issue
|
||
```
|
||
|
||
##### 修改出库单
|
||
|
||
```
|
||
PUT /wm/issue
|
||
```
|
||
|
||
##### 删除出库单
|
||
|
||
```
|
||
DELETE /wm/issue/{issueIds}
|
||
```
|
||
|
||
#### 盘点单接口
|
||
|
||
##### 查询盘点单列表
|
||
|
||
```
|
||
GET /wm/itemconsume
|
||
```
|
||
|
||
##### 新增盘点单
|
||
|
||
```
|
||
POST /wm/itemconsume
|
||
```
|
||
|
||
##### 修改盘点单
|
||
|
||
```
|
||
PUT /wm/itemconsume
|
||
```
|
||
|
||
##### 删除盘点单
|
||
|
||
```
|
||
DELETE /wm/itemconsume/{consumeIds}
|
||
```
|
||
|
||
#### 仓库管理接口
|
||
|
||
##### 查询仓库列表
|
||
|
||
```
|
||
GET /wm/warehouse
|
||
```
|
||
|
||
**请求参数**
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
|--------|------|------|------|
|
||
| warehouseCode | string | 否 | 仓库编码 |
|
||
| warehouseName | string | 否 | 仓库名称 |
|
||
|
||
##### 新增仓库
|
||
|
||
```
|
||
POST /wm/warehouse
|
||
```
|
||
|
||
**请求体**
|
||
|
||
```json
|
||
{
|
||
"warehouseCode": "WH01",
|
||
"warehouseName": "主仓库",
|
||
"location": "A区",
|
||
"area": 1000,
|
||
"charge": "张三"
|
||
}
|
||
```
|
||
|
||
##### 修改仓库
|
||
|
||
```
|
||
PUT /wm/warehouse
|
||
```
|
||
|
||
##### 删除仓库
|
||
|
||
```
|
||
DELETE /wm/warehouse/{warehouseIds}
|
||
```
|
||
|
||
#### 库区管理接口
|
||
|
||
##### 查询库区列表
|
||
|
||
```
|
||
GET /wm/location
|
||
```
|
||
|
||
##### 新增库区
|
||
|
||
```
|
||
POST /wm/location
|
||
```
|
||
|
||
##### 修改库区
|
||
|
||
```
|
||
PUT /wm/location
|
||
```
|
||
|
||
##### 删除库区
|
||
|
||
```
|
||
DELETE /wm/location/{locationIds}
|
||
```
|
||
|
||
#### 库位管理接口
|
||
|
||
##### 查询库位列表
|
||
|
||
```
|
||
GET /wm/area
|
||
```
|
||
|
||
##### 新增库位
|
||
|
||
```
|
||
POST /wm/area
|
||
```
|
||
|
||
##### 修改库位
|
||
|
||
```
|
||
PUT /wm/area
|
||
```
|
||
|
||
##### 删除库位
|
||
|
||
```
|
||
DELETE /wm/area/{areaIds}
|
||
```
|
||
|
||
#### 库存查询接口
|
||
|
||
##### 查询库存列表
|
||
|
||
```
|
||
GET /wm/stock
|
||
```
|
||
|
||
**请求参数**
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
|--------|------|------|------|
|
||
| itemId | integer | 否 | 物料ID |
|
||
| itemCode | string | 否 | 物料编码 |
|
||
| itemName | string | 否 | 物料名称 |
|
||
| warehouseId | integer | 否 | 仓库ID |
|
||
|
||
**响应示例**
|
||
|
||
```json
|
||
{
|
||
"total": 50,
|
||
"rows": [
|
||
{
|
||
"stockId": 1,
|
||
"itemId": 100,
|
||
"itemCode": "M001",
|
||
"itemName": "原材料A",
|
||
"warehouseId": 1,
|
||
"warehouseName": "主仓库",
|
||
"quantityOnHand": 1000,
|
||
"quantityLocked": 100,
|
||
"quantityAvailable": 900
|
||
}
|
||
],
|
||
"code": 200,
|
||
"msg": "查询成功"
|
||
}
|
||
```
|
||
|
||
#### 调拨单接口
|
||
|
||
##### 查询调拨单列表
|
||
|
||
```
|
||
GET /wm/transfer
|
||
```
|
||
|
||
##### 新增调拨单
|
||
|
||
```
|
||
POST /wm/transfer
|
||
```
|
||
|
||
##### 修改调拨单
|
||
|
||
```
|
||
PUT /wm/transfer
|
||
```
|
||
|
||
##### 删除调拨单
|
||
|
||
```
|
||
DELETE /wm/transfer/{transferIds}
|
||
```
|
||
|
||
---
|
||
|
||
## 销售模块
|
||
|
||
### 模块说明
|
||
|
||
销售模块提供销售业务相关功能，包括客户管理、销售订单、发货、退货等。
|
||
|
||
### 功能分类
|
||
|
||
| 标签 | 说明 |
|
||
|------|------|
|
||
| 客户 | 客户主数据管理 |
|
||
| 销售订单 | 销售订单管理 |
|
||
| 发货单 | 发货单管理 |
|
||
| 退货单 | 退货单管理 |
|
||
| 销售发票 | 销售发票管理 |
|
||
|
||
### 接口列表
|
||
|
||
#### 客户管理接口
|
||
|
||
##### 查询客户列表
|
||
|
||
```
|
||
GET /sl/client
|
||
```
|
||
|
||
**请求参数**
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
|--------|------|------|------|
|
||
| clientCode | string | 否 | 客户编码 |
|
||
| clientName | string | 否 | 客户名称 |
|
||
| clientNick | string | 否 | 客户简称 |
|
||
|
||
**响应数据模型: SlClient**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| clientId | integer | 客户ID |
|
||
| clientCode | string | 客户编码 |
|
||
| clientName | string | 客户名称 |
|
||
| clientNick | string | 客户简称 |
|
||
| clientEn | string | 英文名称 |
|
||
| clientDes | string | 客户描述 |
|
||
| clientLogo | string | 客户Logo |
|
||
| clientType | string | 客户类型 |
|
||
| clientLevel | string | 客户级别 |
|
||
| clientSource | string | 客户来源 |
|
||
| clientIndustry | string | 所属行业 |
|
||
| address | string | 地址 |
|
||
| website | string | 网址 |
|
||
| email | string | 邮箱 |
|
||
| tel | string | 电话 |
|
||
| contact1 | string | 联系人1 |
|
||
| contact1Tel | string | 联系人1电话 |
|
||
| contact2 | string | 联系人2 |
|
||
| contact2Tel | string | 联系人2电话 |
|
||
| creditCode | string | 信用代码 |
|
||
| enableFlag | string | 启用状态 |
|
||
|
||
##### 新增客户
|
||
|
||
```
|
||
POST /sl/client
|
||
```
|
||
|
||
##### 修改客户
|
||
|
||
```
|
||
PUT /sl/client
|
||
```
|
||
|
||
##### 删除客户
|
||
|
||
```
|
||
DELETE /sl/client/{clientIds}
|
||
```
|
||
|
||
##### 获取客户详情
|
||
|
||
```
|
||
GET /sl/client/{clientId}
|
||
```
|
||
|
||
#### 销售订单接口
|
||
|
||
##### 查询销售订单列表
|
||
|
||
```
|
||
GET /sl/order
|
||
```
|
||
|
||
**请求参数**
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
|--------|------|------|------|
|
||
| orderCode | string | 否 | 订单编号 |
|
||
| clientId | integer | 否 | 客户ID |
|
||
| orderStatus | string | 否 | 订单状态 |
|
||
|
||
**响应数据模型: SlOrderMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| orderId | integer | 订单ID |
|
||
| orderCode | string | 订单编号 |
|
||
| orderName | string | 订单名称 |
|
||
| clientId | integer | 客户ID |
|
||
| clientCode | string | 客户编码 |
|
||
| clientName | string | 客户名称 |
|
||
| orderDate | string | 订单日期 |
|
||
| deliveryDate | string | 交货日期 |
|
||
| orderStatus | string | 订单状态 |
|
||
| totalAmount | number | 订单总金额 |
|
||
|
||
##### 新增销售订单
|
||
|
||
```
|
||
POST /sl/order
|
||
```
|
||
|
||
**请求体示例**
|
||
|
||
```json
|
||
{
|
||
"orderName": "销售订单001",
|
||
"clientId": 100,
|
||
"orderDate": "2026-01-25",
|
||
"deliveryDate": "2026-02-01",
|
||
"lines": [
|
||
{
|
||
"itemId": 1,
|
||
"itemCode": "P001",
|
||
"quantity": 100,
|
||
"unitPrice": 50.00
|
||
}
|
||
]
|
||
}
|
||
```
|
||
|
||
##### 修改销售订单
|
||
|
||
```
|
||
PUT /sl/order
|
||
```
|
||
|
||
##### 删除销售订单
|
||
|
||
```
|
||
DELETE /sl/order/{orderIds}
|
||
```
|
||
|
||
##### 获取销售订单详情
|
||
|
||
```
|
||
GET /sl/order/{orderId}
|
||
```
|
||
|
||
#### 发货单接口
|
||
|
||
##### 查询发货单列表
|
||
|
||
```
|
||
GET /sl/deliver
|
||
```
|
||
|
||
**请求参数**
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
|--------|------|------|------|
|
||
| deliverCode | string | 否 | 发货单编号 |
|
||
| clientId | integer | 否 | 客户ID |
|
||
| status | string | 否 | 状态 |
|
||
|
||
**响应数据模型: SlDeliverMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| deliverId | integer | 发货单ID |
|
||
| deliverCode | string | 发货单编号 |
|
||
| deliverName | string | 发货单名称 |
|
||
| orderId | integer | 销售订单ID |
|
||
| clientId | integer | 客户ID |
|
||
| clientName | string | 客户名称 |
|
||
| deliverDate | string | 发货日期 |
|
||
| warehouseId | integer | 发货仓库ID |
|
||
| status | string | 状态 |
|
||
|
||
##### 新增发货单
|
||
|
||
```
|
||
POST /sl/deliver
|
||
```
|
||
|
||
##### 修改发货单
|
||
|
||
```
|
||
PUT /sl/deliver
|
||
```
|
||
|
||
##### 删除发货单
|
||
|
||
```
|
||
DELETE /sl/deliver/{deliverIds}
|
||
```
|
||
|
||
#### 退货单接口
|
||
|
||
##### 查询退货单列表
|
||
|
||
```
|
||
GET /sl/saleback
|
||
```
|
||
|
||
**响应数据模型: SlSalebackMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| salebackId | integer | 退货单ID |
|
||
| salebackCode | string | 退货单编号 |
|
||
| orderId | integer | 原销售订单ID |
|
||
| clientId | integer | 客户ID |
|
||
| salebackDate | string | 退货日期 |
|
||
| reason | string | 退货原因 |
|
||
| status | string | 状态 |
|
||
|
||
##### 新增退货单
|
||
|
||
```
|
||
POST /sl/saleback
|
||
```
|
||
|
||
##### 修改退货单
|
||
|
||
```
|
||
PUT /sl/saleback
|
||
```
|
||
|
||
##### 删除退货单
|
||
|
||
```
|
||
DELETE /sl/saleback/{salebackIds}
|
||
```
|
||
|
||
#### 销售发票接口
|
||
|
||
##### 查询销售发票列表
|
||
|
||
```
|
||
GET /sl/invoice
|
||
```
|
||
|
||
##### 新增销售发票
|
||
|
||
```
|
||
POST /sl/invoice
|
||
```
|
||
|
||
##### 修改销售发票
|
||
|
||
```
|
||
PUT /sl/invoice
|
||
```
|
||
|
||
##### 删除销售发票
|
||
|
||
```
|
||
DELETE /sl/invoice/{invoiceIds}
|
||
```
|
||
|
||
---
|
||
|
||
## 计划模块
|
||
|
||
### 模块说明
|
||
|
||
计划模块提供生产计划、物料需求计划等功能。
|
||
|
||
### 功能分类
|
||
|
||
| 标签 | 说明 |
|
||
|------|------|
|
||
| 主生产计划 | MPS主生产计划 |
|
||
| 物料需求计划 | MRP物料需求计划 |
|
||
| 预测需求 | 需求预测管理 |
|
||
|
||
### 接口列表
|
||
|
||
#### 主生产计划接口
|
||
|
||
##### 查询主生产计划列表
|
||
|
||
```
|
||
GET /pl/mps
|
||
```
|
||
|
||
**请求参数**
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
|--------|------|------|------|
|
||
| mpsCode | string | 否 | 计划编号 |
|
||
| planPeriod | string | 否 | 计划周期 |
|
||
| status | string | 否 | 状态 |
|
||
|
||
**响应数据模型: PlMpsMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| mpsId | integer | 计划ID |
|
||
| mpsCode | string | 计划编号 |
|
||
| mpsName | string | 计划名称 |
|
||
| planPeriod | string | 计划周期 |
|
||
| startDate | string | 开始日期 |
|
||
| endDate | string | 结束日期 |
|
||
| status | string | 状态 |
|
||
|
||
##### 新增主生产计划
|
||
|
||
```
|
||
POST /pl/mps
|
||
```
|
||
|
||
##### 修改主生产计划
|
||
|
||
```
|
||
PUT /pl/mps
|
||
```
|
||
|
||
##### 删除主生产计划
|
||
|
||
```
|
||
DELETE /pl/mps/{mpsIds}
|
||
```
|
||
|
||
##### 运行主生产计划
|
||
|
||
```
|
||
POST /pl/mps/run/{mpsId}
|
||
```
|
||
|
||
#### 物料需求计划接口
|
||
|
||
##### 查询物料需求计划列表
|
||
|
||
```
|
||
GET /pl/mrp
|
||
```
|
||
|
||
**请求参数**
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
|--------|------|------|------|
|
||
| mrpCode | string | 否 | MRP编号 |
|
||
| itemId | integer | 否 | 物料ID |
|
||
| status | string | 否 | 状态 |
|
||
|
||
**响应数据模型: PlMrpMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| mrpId | integer | MRP ID |
|
||
| mrpCode | string | MRP编号 |
|
||
| mrpName | string | MRP名称 |
|
||
| mpsId | integer | 关联MPS ID |
|
||
| runDate | string | 运行日期 |
|
||
| status | string | 状态 |
|
||
|
||
##### 新增物料需求计划
|
||
|
||
```
|
||
POST /pl/mrp
|
||
```
|
||
|
||
##### 修改物料需求计划
|
||
|
||
```
|
||
PUT /pl/mrp
|
||
```
|
||
|
||
##### 删除物料需求计划
|
||
|
||
```
|
||
DELETE /pl/mrp/{mrpIds}
|
||
```
|
||
|
||
##### 运行物料需求计划
|
||
|
||
```
|
||
POST /pl/mrp/run/{mrpId}
|
||
```
|
||
|
||
#### 预测需求接口
|
||
|
||
##### 查询预测需求列表
|
||
|
||
```
|
||
GET /pl/forecast
|
||
```
|
||
|
||
##### 新增预测需求
|
||
|
||
```
|
||
POST /pl/forecast
|
||
```
|
||
|
||
##### 修改预测需求
|
||
|
||
```
|
||
PUT /pl/forecast
|
||
```
|
||
|
||
##### 删除预测需求
|
||
|
||
```
|
||
DELETE /pl/forecast/{forecastIds}
|
||
```
|
||
|
||
---
|
||
|
||
## 采购模块
|
||
|
||
### 模块说明
|
||
|
||
采购模块提供采购业务相关功能，包括供应商管理、采购订单、到货、发票等。
|
||
|
||
### 功能分类
|
||
|
||
| 标签 | 说明 |
|
||
|------|------|
|
||
| 供应商 | 供应商主数据管理 |
|
||
| 采购订单 | 采购订单管理 |
|
||
| 到货单 | 采购到货管理 |
|
||
| 采购发票 | 采购发票管理 |
|
||
| 采购入库 | 采购入库单管理 |
|
||
| 采购退料 | 采购退货管理 |
|
||
| 采购发料 | 采购发料管理 |
|
||
|
||
### 接口列表
|
||
|
||
#### 供应商管理接口
|
||
|
||
##### 查询供应商列表
|
||
|
||
```
|
||
GET /po/vendor
|
||
```
|
||
|
||
**请求参数**
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
|--------|------|------|------|
|
||
| vendorCode | string | 否 | 供应商编码 |
|
||
| vendorName | string | 否 | 供应商名称 |
|
||
| vendorNick | string | 否 | 供应商简称 |
|
||
|
||
**响应数据模型: PoVendor**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| vendorId | integer | 供应商ID |
|
||
| vendorCode | string | 供应商编码 |
|
||
| vendorName | string | 供应商名称 |
|
||
| vendorNick | string | 供应商简称 |
|
||
| vendorEn | string | 英文名称 |
|
||
| vendorDes | string | 供应商描述 |
|
||
| vendorType | string | 供应商类型 |
|
||
| vendorLevel | string | 供应商级别 |
|
||
| address | string | 地址 |
|
||
| website | string | 网址 |
|
||
| email | string | 邮箱 |
|
||
| tel | string | 电话 |
|
||
| contact1 | string | 联系人1 |
|
||
| contact1Tel | string | 联系人1电话 |
|
||
| bankName | string | 开户银行 |
|
||
| bankAccount | string | 银行账号 |
|
||
| taxNo | string | 税号 |
|
||
| enableFlag | string | 启用状态 |
|
||
|
||
##### 新增供应商
|
||
|
||
```
|
||
POST /po/vendor
|
||
```
|
||
|
||
##### 修改供应商
|
||
|
||
```
|
||
PUT /po/vendor
|
||
```
|
||
|
||
##### 删除供应商
|
||
|
||
```
|
||
DELETE /po/vendor/{vendorIds}
|
||
```
|
||
|
||
##### 获取供应商详情
|
||
|
||
```
|
||
GET /po/vendor/{vendorId}
|
||
```
|
||
|
||
#### 采购订单接口
|
||
|
||
##### 查询采购订单列表
|
||
|
||
```
|
||
GET /po/order
|
||
```
|
||
|
||
**请求参数**
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
|--------|------|------|------|
|
||
| orderCode | string | 否 | 订单编号 |
|
||
| vendorId | integer | 否 | 供应商ID |
|
||
| orderStatus | string | 否 | 订单状态 |
|
||
|
||
**响应数据模型: PoOrderMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| orderId | integer | 订单ID |
|
||
| orderCode | string | 订单编号 |
|
||
| orderName | string | 订单名称 |
|
||
| vendorId | integer | 供应商ID |
|
||
| vendorCode | string | 供应商编码 |
|
||
| vendorName | string | 供应商名称 |
|
||
| orderDate | string | 订单日期 |
|
||
| deliveryDate | string | 交货日期 |
|
||
| orderStatus | string | 订单状态 |
|
||
| totalAmount | number | 订单总金额 |
|
||
|
||
##### 新增采购订单
|
||
|
||
```
|
||
POST /po/order
|
||
```
|
||
|
||
**请求体示例**
|
||
|
||
```json
|
||
{
|
||
"orderName": "采购订单001",
|
||
"vendorId": 100,
|
||
"orderDate": "2026-01-25",
|
||
"deliveryDate": "2026-02-01",
|
||
"lines": [
|
||
{
|
||
"itemId": 1,
|
||
"itemCode": "M001",
|
||
"quantity": 1000,
|
||
"unitPrice": 10.00
|
||
}
|
||
]
|
||
}
|
||
```
|
||
|
||
##### 修改采购订单
|
||
|
||
```
|
||
PUT /po/order
|
||
```
|
||
|
||
##### 删除采购订单
|
||
|
||
```
|
||
DELETE /po/order/{orderIds}
|
||
```
|
||
|
||
##### 获取采购订单详情
|
||
|
||
```
|
||
GET /po/order/{orderId}
|
||
```
|
||
|
||
#### 到货单接口
|
||
|
||
##### 查询到货单列表
|
||
|
||
```
|
||
GET /po/checkin
|
||
```
|
||
|
||
**响应数据模型: PoCheckinMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| checkinId | integer | 到货单ID |
|
||
| checkinCode | string | 到货单编号 |
|
||
| orderId | integer | 采购订单ID |
|
||
| vendorId | integer | 供应商ID |
|
||
| checkinDate | string | 到货日期 |
|
||
| warehouseId | integer | 入库仓库ID |
|
||
| status | string | 状态 |
|
||
|
||
##### 新增到货单
|
||
|
||
```
|
||
POST /po/checkin
|
||
```
|
||
|
||
##### 修改到货单
|
||
|
||
```
|
||
PUT /po/checkin
|
||
```
|
||
|
||
##### 删除到货单
|
||
|
||
```
|
||
DELETE /po/checkin/{checkinIds}
|
||
```
|
||
|
||
#### 采购入库接口
|
||
|
||
##### 查询采购入库单列表
|
||
|
||
```
|
||
GET /po/product
|
||
```
|
||
|
||
##### 新增采购入库单
|
||
|
||
```
|
||
POST /po/product
|
||
```
|
||
|
||
##### 修改采购入库单
|
||
|
||
```
|
||
PUT /po/product
|
||
```
|
||
|
||
##### 删除采购入库单
|
||
|
||
```
|
||
DELETE /po/product/{productIds}
|
||
```
|
||
|
||
#### 采购发票接口
|
||
|
||
##### 查询采购发票列表
|
||
|
||
```
|
||
GET /po/fapiao
|
||
```
|
||
|
||
**响应数据模型: PoFapiaoMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| fapiaoId | integer | 发票ID |
|
||
| fapiaoCode | string | 发票编号 |
|
||
| fapiaoNo | string | 发票号码 |
|
||
| vendorId | integer | 供应商ID |
|
||
| fapiaoDate | string | 发票日期 |
|
||
| fapiaoAmount | number | 发票金额 |
|
||
| taxAmount | number | 税额 |
|
||
| status | string | 状态 |
|
||
|
||
##### 新增采购发票
|
||
|
||
```
|
||
POST /po/fapiao
|
||
```
|
||
|
||
##### 修改采购发票
|
||
|
||
```
|
||
PUT /po/fapiao
|
||
```
|
||
|
||
##### 删除采购发票
|
||
|
||
```
|
||
DELETE /po/fapiao/{fapiaoIds}
|
||
```
|
||
|
||
#### 采购退料接口
|
||
|
||
##### 查询采购退料单列表
|
||
|
||
```
|
||
GET /po/unpick
|
||
```
|
||
|
||
##### 新增采购退料单
|
||
|
||
```
|
||
POST /po/unpick
|
||
```
|
||
|
||
##### 修改采购退料单
|
||
|
||
```
|
||
PUT /po/unpick
|
||
```
|
||
|
||
##### 删除采购退料单
|
||
|
||
```
|
||
DELETE /po/unpick/{unpickIds}
|
||
```
|
||
|
||
#### 采购发料接口
|
||
|
||
##### 查询采购发料单列表
|
||
|
||
```
|
||
GET /po/pick
|
||
```
|
||
|
||
##### 新增采购发料单
|
||
|
||
```
|
||
POST /po/pick
|
||
```
|
||
|
||
##### 修改采购发料单
|
||
|
||
```
|
||
PUT /po/pick
|
||
```
|
||
|
||
##### 删除采购发料单
|
||
|
||
```
|
||
DELETE /po/pick/{pickIds}
|
||
```
|
||
|
||
---
|
||
|
||
## 生产模块
|
||
|
||
### 模块说明
|
||
|
||
生产模块提供生产执行相关功能，包括工单管理、生产报工、质检等。
|
||
|
||
### 功能分类
|
||
|
||
| 标签 | 说明 |
|
||
|------|------|
|
||
| 生产工单 | 生产工单管理 |
|
||
| 生产领料 | 生产领料单管理 |
|
||
| 生产入库 | 生产入库单管理 |
|
||
| 生产退料 | 生产退料单管理 |
|
||
| 生产报工 | 工序报工管理 |
|
||
| 工艺路线 | 工艺路线定义 |
|
||
| 工序 | 工序定义 |
|
||
| 工作站 | 工作站管理 |
|
||
|
||
### 接口列表
|
||
|
||
#### 生产工单接口
|
||
|
||
##### 查询生产工单列表
|
||
|
||
```
|
||
GET /pd/workorder
|
||
```
|
||
|
||
**请求参数**
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
|--------|------|------|------|
|
||
| workorderCode | string | 否 | 工单编号 |
|
||
| workorderName | string | 否 | 工单名称 |
|
||
| itemId | integer | 否 | 产品ID |
|
||
| status | string | 否 | 工单状态 |
|
||
|
||
**响应数据模型: PdWorkorderMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| workorderId | integer | 工单ID |
|
||
| workorderCode | string | 工单编号 |
|
||
| workorderName | string | 工单名称 |
|
||
| itemId | integer | 产品ID |
|
||
| itemCode | string | 产品编码 |
|
||
| itemName | string | 产品名称 |
|
||
| specification | string | 规格型号 |
|
||
| quantity | number | 计划数量 |
|
||
| quantityProduced | number | 已完成数量 |
|
||
| unitOfMeasure | string | 单位 |
|
||
| planStartDate | string | 计划开始日期 |
|
||
| planEndDate | string | 计划结束日期 |
|
||
| actualStartDate | string | 实际开始日期 |
|
||
| actualEndDate | string | 实际结束日期 |
|
||
| status | string | 工单状态 |
|
||
|
||
##### 新增生产工单
|
||
|
||
```
|
||
POST /pd/workorder
|
||
```
|
||
|
||
**请求体示例**
|
||
|
||
```json
|
||
{
|
||
"workorderName": "生产工单001",
|
||
"itemId": 100,
|
||
"quantity": 1000,
|
||
"planStartDate": "2026-01-25",
|
||
"planEndDate": "2026-02-01"
|
||
}
|
||
```
|
||
|
||
##### 修改生产工单
|
||
|
||
```
|
||
PUT /pd/workorder
|
||
```
|
||
|
||
##### 删除生产工单
|
||
|
||
```
|
||
DELETE /pd/workorder/{workorderIds}
|
||
```
|
||
|
||
##### 获取生产工单详情
|
||
|
||
```
|
||
GET /pd/workorder/{workorderId}
|
||
```
|
||
|
||
##### 生产工单下达
|
||
|
||
```
|
||
POST /pd/workorder/release/{workorderId}
|
||
```
|
||
|
||
##### 生产工单完工
|
||
|
||
```
|
||
POST /pd/workorder/complete/{workorderId}
|
||
```
|
||
|
||
#### 生产领料接口
|
||
|
||
##### 查询生产领料单列表
|
||
|
||
```
|
||
GET /pd/pick
|
||
```
|
||
|
||
**响应数据模型: PdPickMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| pickId | integer | 领料单ID |
|
||
| pickCode | string | 领料单编号 |
|
||
| workorderId | integer | 工单ID |
|
||
| warehouseId | integer | 仓库ID |
|
||
| pickDate | string | 领料日期 |
|
||
| status | string | 状态 |
|
||
|
||
##### 新增生产领料单
|
||
|
||
```
|
||
POST /pd/pick
|
||
```
|
||
|
||
##### 修改生产领料单
|
||
|
||
```
|
||
PUT /pd/pick
|
||
```
|
||
|
||
##### 删除生产领料单
|
||
|
||
```
|
||
DELETE /pd/pick/{pickIds}
|
||
```
|
||
|
||
#### 生产入库接口
|
||
|
||
##### 查询生产入库单列表
|
||
|
||
```
|
||
GET /pd/product
|
||
```
|
||
|
||
**响应数据模型: PdProductMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| productId | integer | 入库单ID |
|
||
| productCode | string | 入库单编号 |
|
||
| workorderId | integer | 工单ID |
|
||
| warehouseId | integer | 仓库ID |
|
||
| productDate | string | 入库日期 |
|
||
| quantity | number | 入库数量 |
|
||
| status | string | 状态 |
|
||
|
||
##### 新增生产入库单
|
||
|
||
```
|
||
POST /pd/product
|
||
```
|
||
|
||
##### 修改生产入库单
|
||
|
||
```
|
||
PUT /pd/product
|
||
```
|
||
|
||
##### 删除生产入库单
|
||
|
||
```
|
||
DELETE /pd/product/{productIds}
|
||
```
|
||
|
||
#### 生产退料接口
|
||
|
||
##### 查询生产退料单列表
|
||
|
||
```
|
||
GET /pd/unpick
|
||
```
|
||
|
||
##### 新增生产退料单
|
||
|
||
```
|
||
POST /pd/unpick
|
||
```
|
||
|
||
##### 修改生产退料单
|
||
|
||
```
|
||
PUT /pd/unpick
|
||
```
|
||
|
||
##### 删除生产退料单
|
||
|
||
```
|
||
DELETE /pd/unpick/{unpickIds}
|
||
```
|
||
|
||
#### 生产报工接口
|
||
|
||
##### 查询生产报工列表
|
||
|
||
```
|
||
GET /pd/feedback
|
||
```
|
||
|
||
**响应数据模型: PdFeedbackMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| feedbackId | integer | 报工ID |
|
||
| feedbackCode | string | 报工单号 |
|
||
| workorderId | integer | 工单ID |
|
||
| processId | integer | 工序ID |
|
||
| workstationId | integer | 工作站ID |
|
||
| feedbackDate | string | 报工日期 |
|
||
| quantityFeedback | number | 报工数量 |
|
||
| quantityQualified | number | 合格数量 |
|
||
| quantityUnqualified | number | 不合格数量 |
|
||
| workingTime | number | 工时(小时) |
|
||
|
||
##### 新增报工
|
||
|
||
```
|
||
POST /pd/feedback
|
||
```
|
||
|
||
##### 修改报工
|
||
|
||
```
|
||
PUT /pd/feedback
|
||
```
|
||
|
||
##### 删除报工
|
||
|
||
```
|
||
DELETE /pd/feedback/{feedbackIds}
|
||
```
|
||
|
||
#### 工艺路线接口
|
||
|
||
##### 查询工艺路线列表
|
||
|
||
```
|
||
GET /pd/route
|
||
```
|
||
|
||
**响应数据模型: PdRouteMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| routeId | integer | 工艺路线ID |
|
||
| routeCode | string | 工艺路线编码 |
|
||
| routeName | string | 工艺路线名称 |
|
||
| routeDesc | string | 描述 |
|
||
| enableFlag | string | 启用状态 |
|
||
|
||
##### 新增工艺路线
|
||
|
||
```
|
||
POST /pd/route
|
||
```
|
||
|
||
##### 修改工艺路线
|
||
|
||
```
|
||
PUT /pd/route
|
||
```
|
||
|
||
##### 删除工艺路线
|
||
|
||
```
|
||
DELETE /pd/route/{routeIds}
|
||
```
|
||
|
||
#### 工序接口
|
||
|
||
##### 查询工序列表
|
||
|
||
```
|
||
GET /pd/process
|
||
```
|
||
|
||
**响应数据模型: PdProcess**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| processId | integer | 工序ID |
|
||
| processCode | string | 工序编码 |
|
||
| processName | string | 工序名称 |
|
||
| processType | string | 工序类型 |
|
||
| workstationId | integer | 默认工作站ID |
|
||
| standardTime | number | 标准工时 |
|
||
| enableFlag | string | 启用状态 |
|
||
|
||
##### 新增工序
|
||
|
||
```
|
||
POST /pd/process
|
||
```
|
||
|
||
##### 修改工序
|
||
|
||
```
|
||
PUT /pd/process
|
||
```
|
||
|
||
##### 删除工序
|
||
|
||
```
|
||
DELETE /pd/process/{processIds}
|
||
```
|
||
|
||
#### 工作站接口
|
||
|
||
##### 查询工作站列表
|
||
|
||
```
|
||
GET /pd/workstation
|
||
```
|
||
|
||
**响应数据模型: PdWorkstation**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| workstationId | integer | 工作站ID |
|
||
| workstationCode | string | 工作站编码 |
|
||
| workstationName | string | 工作站名称 |
|
||
| workshopId | integer | 车间ID |
|
||
| capacity | number | 产能 |
|
||
| enableFlag | string | 启用状态 |
|
||
|
||
##### 新增工作站
|
||
|
||
```
|
||
POST /pd/workstation
|
||
```
|
||
|
||
##### 修改工作站
|
||
|
||
```
|
||
PUT /pd/workstation
|
||
```
|
||
|
||
##### 删除工作站
|
||
|
||
```
|
||
DELETE /pd/workstation/{workstationIds}
|
||
```
|
||
|
||
---
|
||
|
||
## 物料模块
|
||
|
||
### 模块说明
|
||
|
||
物料模块提供物料主数据管理相关功能。
|
||
|
||
### 功能分类
|
||
|
||
| 标签 | 说明 |
|
||
|------|------|
|
||
| 物料 | 物料主数据管理 |
|
||
| 物料分类 | 物料分类管理 |
|
||
| 计量单位 | 计量单位管理 |
|
||
| 物料BOM | 物料清单管理 |
|
||
| 供应商物料 | 供应商物料对照 |
|
||
| 客户物料 | 客户物料对照 |
|
||
|
||
### 接口列表
|
||
|
||
#### 物料管理接口
|
||
|
||
##### 查询物料列表
|
||
|
||
```
|
||
GET /md/item
|
||
```
|
||
|
||
**请求参数**
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
|--------|------|------|------|
|
||
| itemCode | string | 否 | 物料编码 |
|
||
| itemName | string | 否 | 物料名称 |
|
||
| specification | string | 否 | 规格型号 |
|
||
| itemTypeId | integer | 否 | 物料分类ID |
|
||
| itemOrProduct | string | 否 | 物料/产品标识 |
|
||
|
||
**响应数据模型: MdItem**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| itemId | integer | 物料ID |
|
||
| itemCode | string | 物料编码 |
|
||
| itemName | string | 物料名称 |
|
||
| specification | string | 规格型号 |
|
||
| unitOfMeasure | string | 计量单位 |
|
||
| itemTypeId | integer | 物料分类ID |
|
||
| itemTypeName | string | 物料分类名称 |
|
||
| itemOrProduct | string | 物料/产品 (ITEM/PRODUCT) |
|
||
| safeStockFlag | string | 是否启用安全库存 |
|
||
| minStock | number | 最小库存 |
|
||
| maxStock | number | 最大库存 |
|
||
| enableFlag | string | 启用状态 |
|
||
| remark | string | 备注 |
|
||
|
||
##### 新增物料
|
||
|
||
```
|
||
POST /md/item
|
||
```
|
||
|
||
**请求体示例**
|
||
|
||
```json
|
||
{
|
||
"itemCode": "M001",
|
||
"itemName": "原材料A",
|
||
"specification": "100*50*20",
|
||
"unitOfMeasure": "PCS",
|
||
"itemTypeId": 1,
|
||
"itemOrProduct": "ITEM",
|
||
"safeStockFlag": "Y",
|
||
"minStock": 100,
|
||
"maxStock": 10000
|
||
}
|
||
```
|
||
|
||
##### 修改物料
|
||
|
||
```
|
||
PUT /md/item
|
||
```
|
||
|
||
##### 删除物料
|
||
|
||
```
|
||
DELETE /md/item/{itemIds}
|
||
```
|
||
|
||
##### 获取物料详情
|
||
|
||
```
|
||
GET /md/item/{itemId}
|
||
```
|
||
|
||
#### 物料分类接口
|
||
|
||
##### 查询物料分类列表
|
||
|
||
```
|
||
GET /md/itemtype
|
||
```
|
||
|
||
**响应数据模型: MdItemType**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| itemTypeId | integer | 分类ID |
|
||
| itemTypeCode | string | 分类编码 |
|
||
| itemTypeName | string | 分类名称 |
|
||
| parentTypeId | integer | 父分类ID |
|
||
| orderNum | integer | 排序号 |
|
||
| enableFlag | string | 启用状态 |
|
||
|
||
##### 新增物料分类
|
||
|
||
```
|
||
POST /md/itemtype
|
||
```
|
||
|
||
##### 修改物料分类
|
||
|
||
```
|
||
PUT /md/itemtype
|
||
```
|
||
|
||
##### 删除物料分类
|
||
|
||
```
|
||
DELETE /md/itemtype/{itemTypeIds}
|
||
```
|
||
|
||
#### 计量单位接口
|
||
|
||
##### 查询计量单位列表
|
||
|
||
```
|
||
GET /md/uom
|
||
```
|
||
|
||
**响应数据模型: MdUom**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| uomId | integer | 单位ID |
|
||
| uomCode | string | 单位编码 |
|
||
| uomName | string | 单位名称 |
|
||
| isPrimary | string | 是否主单位 |
|
||
| enableFlag | string | 启用状态 |
|
||
|
||
##### 新增计量单位
|
||
|
||
```
|
||
POST /md/uom
|
||
```
|
||
|
||
##### 修改计量单位
|
||
|
||
```
|
||
PUT /md/uom
|
||
```
|
||
|
||
##### 删除计量单位
|
||
|
||
```
|
||
DELETE /md/uom/{uomIds}
|
||
```
|
||
|
||
#### 物料BOM接口
|
||
|
||
##### 查询物料BOM列表
|
||
|
||
```
|
||
GET /md/bom
|
||
```
|
||
|
||
**请求参数**
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
|--------|------|------|------|
|
||
| itemId | integer | 否 | 产品ID |
|
||
| itemCode | string | 否 | 产品编码 |
|
||
|
||
**响应数据模型: MdBomMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| bomId | integer | BOM ID |
|
||
| itemId | integer | 产品ID |
|
||
| itemCode | string | 产品编码 |
|
||
| itemName | string | 产品名称 |
|
||
| bomVersion | string | BOM版本 |
|
||
| enableFlag | string | 启用状态 |
|
||
| lines | array | BOM明细行 |
|
||
|
||
**BOM明细行: MdBomSalve**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| lineId | integer | 行ID |
|
||
| bomId | integer | BOM ID |
|
||
| itemId | integer | 组件物料ID |
|
||
| itemCode | string | 组件物料编码 |
|
||
| itemName | string | 组件物料名称 |
|
||
| quantity | number | 用量 |
|
||
| unitOfMeasure | string | 单位 |
|
||
|
||
##### 新增物料BOM
|
||
|
||
```
|
||
POST /md/bom
|
||
```
|
||
|
||
##### 修改物料BOM
|
||
|
||
```
|
||
PUT /md/bom
|
||
```
|
||
|
||
##### 删除物料BOM
|
||
|
||
```
|
||
DELETE /md/bom/{bomIds}
|
||
```
|
||
|
||
#### 供应商物料接口
|
||
|
||
##### 查询供应商物料对照
|
||
|
||
```
|
||
GET /md/vendoritem
|
||
```
|
||
|
||
##### 新增供应商物料对照
|
||
|
||
```
|
||
POST /md/vendoritem
|
||
```
|
||
|
||
##### 修改供应商物料对照
|
||
|
||
```
|
||
PUT /md/vendoritem
|
||
```
|
||
|
||
##### 删除供应商物料对照
|
||
|
||
```
|
||
DELETE /md/vendoritem/{vendorItemIds}
|
||
```
|
||
|
||
#### 客户物料接口
|
||
|
||
##### 查询客户物料对照
|
||
|
||
```
|
||
GET /md/clientitem
|
||
```
|
||
|
||
##### 新增客户物料对照
|
||
|
||
```
|
||
POST /md/clientitem
|
||
```
|
||
|
||
##### 修改客户物料对照
|
||
|
||
```
|
||
PUT /md/clientitem
|
||
```
|
||
|
||
##### 删除客户物料对照
|
||
|
||
```
|
||
DELETE /md/clientitem/{clientItemIds}
|
||
```
|
||
|
||
---
|
||
|
||
## 研发模块
|
||
|
||
### 模块说明
|
||
|
||
研发模块提供研发BOM、样品配方等功能。
|
||
|
||
### 功能分类
|
||
|
||
| 标签 | 说明 |
|
||
|------|------|
|
||
| 物料清单 | 研发BOM管理 |
|
||
| 样品配方 | 样品配方管理 |
|
||
| 孪生物料 | 物料孪生管理 |
|
||
| 放量 | 放量管理 |
|
||
| 设置 | 研发参数设置 |
|
||
|
||
### 接口列表
|
||
|
||
#### 研发物料清单(EBOM)接口
|
||
|
||
##### 查询研发BOM列表
|
||
|
||
```
|
||
GET /rd/ebom
|
||
```
|
||
|
||
**请求参数**
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
|--------|------|------|------|
|
||
| itemId | integer | 否 | 产品ID |
|
||
| itemCode | string | 否 | 产品编码 |
|
||
| bomVersion | string | 否 | BOM版本 |
|
||
|
||
**响应数据模型: RdEbomMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| ebomId | integer | EBOM ID |
|
||
| itemId | integer | 产品ID |
|
||
| itemCode | string | 产品编码 |
|
||
| itemName | string | 产品名称 |
|
||
| bomVersion | string | BOM版本 |
|
||
| designer | string | 设计人员 |
|
||
| designDate | string | 设计日期 |
|
||
| status | string | 状态 |
|
||
|
||
**EBOM明细: RdEbomSalve**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| lineId | integer | 行ID |
|
||
| ebomId | integer | EBOM ID |
|
||
| itemId | integer | 组件物料ID |
|
||
| itemCode | string | 组件物料编码 |
|
||
| itemName | string | 组件物料名称 |
|
||
| quantity | number | 用量 |
|
||
| unitOfMeasure | string | 单位 |
|
||
| position | string | 位置号 |
|
||
|
||
##### 新增研发BOM
|
||
|
||
```
|
||
POST /rd/ebom
|
||
```
|
||
|
||
##### 修改研发BOM
|
||
|
||
```
|
||
PUT /rd/ebom
|
||
```
|
||
|
||
##### 删除研发BOM
|
||
|
||
```
|
||
DELETE /rd/ebom/{ebomIds}
|
||
```
|
||
|
||
#### 样品配方接口
|
||
|
||
##### 查询样品配方列表
|
||
|
||
```
|
||
GET /rd/sample
|
||
```
|
||
|
||
**响应数据模型: RdSampleMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| sampleId | integer | 样品ID |
|
||
| sampleCode | string | 样品编码 |
|
||
| sampleName | string | 样品名称 |
|
||
| sampleVersion | string | 样品版本 |
|
||
| designer | string | 设计人员 |
|
||
| designDate | string | 设计日期 |
|
||
| status | string | 状态 |
|
||
|
||
**样品配方明细: RdSampleSalve**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| lineId | integer | 行ID |
|
||
| sampleId | integer | 样品ID |
|
||
| itemId | integer | 原料ID |
|
||
| itemCode | string | 原料编码 |
|
||
| itemName | string | 原料名称 |
|
||
| quantity | number | 用量 |
|
||
| ratio | number | 配比(%) |
|
||
|
||
##### 新增样品配方
|
||
|
||
```
|
||
POST /rd/sample
|
||
```
|
||
|
||
##### 修改样品配方
|
||
|
||
```
|
||
PUT /rd/sample
|
||
```
|
||
|
||
##### 删除样品配方
|
||
|
||
```
|
||
DELETE /rd/sample/{sampleIds}
|
||
```
|
||
|
||
#### 孪生物料接口
|
||
|
||
##### 查询孪生物料列表
|
||
|
||
```
|
||
GET /rd/twin
|
||
```
|
||
|
||
**响应数据模型: RdTwinMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| twinId | integer | 孪生ID |
|
||
| sourceItemId | integer | 源物料ID |
|
||
| sourceItemCode | string | 源物料编码 |
|
||
| targetItemId | integer | 目标物料ID |
|
||
| targetItemCode | string | 目标物料编码 |
|
||
| conversionRate | number | 转换率 |
|
||
|
||
##### 新增孪生物料
|
||
|
||
```
|
||
POST /rd/twin
|
||
```
|
||
|
||
##### 修改孪生物料
|
||
|
||
```
|
||
PUT /rd/twin
|
||
```
|
||
|
||
##### 删除孪生物料
|
||
|
||
```
|
||
DELETE /rd/twin/{twinIds}
|
||
```
|
||
|
||
#### 放量接口
|
||
|
||
##### 查询放量记录列表
|
||
|
||
```
|
||
GET /rd/tret
|
||
```
|
||
|
||
**响应数据模型: RdTret**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| tretId | integer | 放量ID |
|
||
| itemId | integer | 物料ID |
|
||
| itemCode | string | 物料编码 |
|
||
| quantity | number | 放量数量 |
|
||
| tretDate | string | 放量日期 |
|
||
| reason | string | 放量原因 |
|
||
|
||
##### 新增放量
|
||
|
||
```
|
||
POST /rd/tret
|
||
```
|
||
|
||
##### 修改放量
|
||
|
||
```
|
||
PUT /rd/tret
|
||
```
|
||
|
||
##### 删除放量
|
||
|
||
```
|
||
DELETE /rd/tret/{tretIds}
|
||
```
|
||
|
||
#### 研发设置接口
|
||
|
||
##### 查询研发设置
|
||
|
||
```
|
||
GET /rd/setting
|
||
```
|
||
|
||
**响应数据模型: RdSetting**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| settingId | integer | 设置ID |
|
||
| settingCode | string | 设置编码 |
|
||
| settingName | string | 设置名称 |
|
||
| settingValue | string | 设置值 |
|
||
|
||
##### 修改研发设置
|
||
|
||
```
|
||
PUT /rd/setting
|
||
```
|
||
|
||
---
|
||
|
||
## 委外模块
|
||
|
||
### 模块说明
|
||
|
||
委外模块提供委外加工相关功能。
|
||
|
||
### 功能分类
|
||
|
||
| 标签 | 说明 |
|
||
|------|------|
|
||
| 委外委外商 | 委外商管理 |
|
||
| 委外订单 | 委外订单管理 |
|
||
| 到货单 | 委外到货管理 |
|
||
| 委外入库单 | 委外入库管理 |
|
||
| 委外发料单 | 委外发料管理 |
|
||
| 委外退料单 | 委外退料管理 |
|
||
| 委外发票 | 委外发票管理 |
|
||
|
||
### 接口列表
|
||
|
||
#### 委外商管理接口
|
||
|
||
##### 查询委外商列表
|
||
|
||
```
|
||
GET /pu/supplier
|
||
```
|
||
|
||
**响应数据模型: PuSupplier**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| supplierId | integer | 委外商ID |
|
||
| supplierCode | string | 委外商编码 |
|
||
| supplierName | string | 委外商名称 |
|
||
| supplierNick | string | 委外商简称 |
|
||
| supplierType | string | 委外商类型 |
|
||
| address | string | 地址 |
|
||
| contact | string | 联系人 |
|
||
| tel | string | 电话 |
|
||
| bankName | string | 开户银行 |
|
||
| bankAccount | string | 银行账号 |
|
||
| enableFlag | string | 启用状态 |
|
||
|
||
##### 新增委外商
|
||
|
||
```
|
||
POST /pu/supplier
|
||
```
|
||
|
||
##### 修改委外商
|
||
|
||
```
|
||
PUT /pu/supplier
|
||
```
|
||
|
||
##### 删除委外商
|
||
|
||
```
|
||
DELETE /pu/supplier/{supplierIds}
|
||
```
|
||
|
||
#### 委外订单接口
|
||
|
||
##### 查询委外订单列表
|
||
|
||
```
|
||
GET /pu/order
|
||
```
|
||
|
||
**响应数据模型: PuOrderMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| orderId | integer | 订单ID |
|
||
| orderCode | string | 订单编号 |
|
||
| orderName | string | 订单名称 |
|
||
| supplierId | integer | 委外商ID |
|
||
| supplierName | string | 委外商名称 |
|
||
| orderDate | string | 订单日期 |
|
||
| deliveryDate | string | 交货日期 |
|
||
| status | string | 状态 |
|
||
| totalAmount | number | 订单总金额 |
|
||
|
||
##### 新增委外订单
|
||
|
||
```
|
||
POST /pu/order
|
||
```
|
||
|
||
##### 修改委外订单
|
||
|
||
```
|
||
PUT /pu/order
|
||
```
|
||
|
||
##### 删除委外订单
|
||
|
||
```
|
||
DELETE /pu/order/{orderIds}
|
||
```
|
||
|
||
#### 委外到货单接口
|
||
|
||
##### 查询委外到货单列表
|
||
|
||
```
|
||
GET /pu/checkin
|
||
```
|
||
|
||
**响应数据模型: PuCheckinMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| checkinId | integer | 到货单ID |
|
||
| checkinCode | string | 到货单编号 |
|
||
| orderId | integer | 委外订单ID |
|
||
| supplierId | integer | 委外商ID |
|
||
| checkinDate | string | 到货日期 |
|
||
| status | string | 状态 |
|
||
|
||
##### 新增委外到货单
|
||
|
||
```
|
||
POST /pu/checkin
|
||
```
|
||
|
||
##### 修改委外到货单
|
||
|
||
```
|
||
PUT /pu/checkin
|
||
```
|
||
|
||
##### 删除委外到货单
|
||
|
||
```
|
||
DELETE /pu/checkin/{checkinIds}
|
||
```
|
||
|
||
#### 委外入库单接口
|
||
|
||
##### 查询委外入库单列表
|
||
|
||
```
|
||
GET /pu/product
|
||
```
|
||
|
||
**响应数据模型: PuProductMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| productId | integer | 入库单ID |
|
||
| productCode | string | 入库单编号 |
|
||
| orderId | integer | 委外订单ID |
|
||
| warehouseId | integer | 仓库ID |
|
||
| productDate | string | 入库日期 |
|
||
| status | string | 状态 |
|
||
|
||
##### 新增委外入库单
|
||
|
||
```
|
||
POST /pu/product
|
||
```
|
||
|
||
##### 修改委外入库单
|
||
|
||
```
|
||
PUT /pu/product
|
||
```
|
||
|
||
##### 删除委外入库单
|
||
|
||
```
|
||
DELETE /pu/product/{productIds}
|
||
```
|
||
|
||
#### 委外发料单接口
|
||
|
||
##### 查询委外发料单列表
|
||
|
||
```
|
||
GET /pu/pick
|
||
```
|
||
|
||
**响应数据模型: PuPickMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| pickId | integer | 发料单ID |
|
||
| pickCode | string | 发料单编号 |
|
||
| orderId | integer | 委外订单ID |
|
||
| warehouseId | integer | 仓库ID |
|
||
| pickDate | string | 发料日期 |
|
||
| status | string | 状态 |
|
||
|
||
##### 新增委外发料单
|
||
|
||
```
|
||
POST /pu/pick
|
||
```
|
||
|
||
##### 修改委外发料单
|
||
|
||
```
|
||
PUT /pu/pick
|
||
```
|
||
|
||
##### 删除委外发料单
|
||
|
||
```
|
||
DELETE /pu/pick/{pickIds}
|
||
```
|
||
|
||
#### 委外退料单接口
|
||
|
||
##### 查询委外退料单列表
|
||
|
||
```
|
||
GET /pu/unpick
|
||
```
|
||
|
||
**响应数据模型: PuUnPickMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| unpickId | integer | 退料单ID |
|
||
| unpickCode | string | 退料单编号 |
|
||
| orderId | integer | 委外订单ID |
|
||
| warehouseId | integer | 仓库ID |
|
||
| unpickDate | string | 退料日期 |
|
||
| status | string | 状态 |
|
||
|
||
##### 新增委外退料单
|
||
|
||
```
|
||
POST /pu/unpick
|
||
```
|
||
|
||
##### 修改委外退料单
|
||
|
||
```
|
||
PUT /pu/unpick
|
||
```
|
||
|
||
##### 删除委外退料单
|
||
|
||
```
|
||
DELETE /pu/unpick/{unpickIds}
|
||
```
|
||
|
||
#### 委外发票接口
|
||
|
||
##### 查询委外发票列表
|
||
|
||
```
|
||
GET /pu/fapiao
|
||
```
|
||
|
||
**响应数据模型: PuFapiaoMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| fapiaoId | integer | 发票ID |
|
||
| fapiaoCode | string | 发票编号 |
|
||
| fapiaoNo | string | 发票号码 |
|
||
| supplierId | integer | 委外商ID |
|
||
| fapiaoDate | string | 发票日期 |
|
||
| fapiaoAmount | number | 发票金额 |
|
||
| taxAmount | number | 税额 |
|
||
| status | string | 状态 |
|
||
|
||
##### 新增委外发票
|
||
|
||
```
|
||
POST /pu/fapiao
|
||
```
|
||
|
||
##### 修改委外发票
|
||
|
||
```
|
||
PUT /pu/fapiao
|
||
```
|
||
|
||
##### 删除委外发票
|
||
|
||
```
|
||
DELETE /pu/fapiao/{fapiaoIds}
|
||
```
|
||
|
||
---
|
||
|
||
## 财务模块
|
||
|
||
### 模块说明
|
||
|
||
财务模块提供应收应付、凭证、成本核算等财务管理功能。
|
||
|
||
### 功能分类
|
||
|
||
| 标签 | 说明 |
|
||
|------|------|
|
||
| 财务期间 | 财务期间管理 |
|
||
| 财务账套 | 财务账套管理 |
|
||
| 科目 | 会计科目管理 |
|
||
| 科目明细 | 科目明细管理 |
|
||
| 科目期初 | 科目期初余额 |
|
||
| 科目汇总 | 科目汇总表 |
|
||
| 凭证 | 会计凭证管理 |
|
||
| 日记帐 | 日记帐管理 |
|
||
| 财务应收 | 应收账款管理 |
|
||
| 应收明细期初 | 应收期初余额 |
|
||
| 应收账款报表 | 应收账款报表 |
|
||
| 应付单主表 | 应付单管理 |
|
||
| 应付账款报表 | 应付账款报表 |
|
||
| 收款单 | 收款单管理 |
|
||
| 付款单 | 付款单管理 |
|
||
| 销售发票 | 销售发票管理 |
|
||
| 发票抵扣 | 发票抵扣管理 |
|
||
| 往来科目 | 往来科目设置 |
|
||
| 成本主表 | 成本核算主表 |
|
||
| 成本入库 | 成本入库管理 |
|
||
| 核算汇总 | 成本核算汇总 |
|
||
| 结算主表 | 结算单管理 |
|
||
| 财务报表 | 财务报表 |
|
||
| 原材料明细 | 原材料明细账 |
|
||
| 原材料期初 | 原材料期初 |
|
||
| 材料分类 | 材料分类管理 |
|
||
| 车间定义 | 车间定义 |
|
||
| 制造费用 | 制造费用管理 |
|
||
| 产线费用 | 产线费用管理 |
|
||
| 加工费 | 加工费管理 |
|
||
| 工人工资 | 工人工资管理 |
|
||
| 销售费用 | 销售费用管理 |
|
||
|
||
### 接口列表
|
||
|
||
#### 财务期间接口
|
||
|
||
##### 查询财务期间列表
|
||
|
||
```
|
||
GET /fd/period
|
||
```
|
||
|
||
**响应数据模型: FdPeriod**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| periodId | integer | 期间ID |
|
||
| periodCode | string | 期间编码 |
|
||
| periodName | string | 期间名称 |
|
||
| year | integer | 年份 |
|
||
| month | integer | 月份 |
|
||
| startDate | string | 开始日期 |
|
||
| endDate | string | 结束日期 |
|
||
| status | string | 状态(OPEN/CLOSED) |
|
||
|
||
##### 新增财务期间
|
||
|
||
```
|
||
POST /fd/period
|
||
```
|
||
|
||
##### 修改财务期间
|
||
|
||
```
|
||
PUT /fd/period
|
||
```
|
||
|
||
##### 关闭财务期间
|
||
|
||
```
|
||
POST /fd/period/close/{periodId}
|
||
```
|
||
|
||
#### 财务账套接口
|
||
|
||
##### 查询账套列表
|
||
|
||
```
|
||
GET /fd/books
|
||
```
|
||
|
||
**响应数据模型: FdBooks**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| booksId | integer | 账套ID |
|
||
| booksCode | string | 账套编码 |
|
||
| booksName | string | 账套名称 |
|
||
| currency | string | 本位币 |
|
||
| startDate | string | 启用日期 |
|
||
| enableFlag | string | 启用状态 |
|
||
|
||
##### 新增账套
|
||
|
||
```
|
||
POST /fd/books
|
||
```
|
||
|
||
##### 修改账套
|
||
|
||
```
|
||
PUT /fd/books
|
||
```
|
||
|
||
#### 科目管理接口
|
||
|
||
##### 查询科目列表
|
||
|
||
```
|
||
GET /fd/ledger
|
||
```
|
||
|
||
**响应数据模型: FdLedger**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| ledgerId | integer | 科目ID |
|
||
| ledgerCode | string | 科目编码 |
|
||
| ledgerName | string | 科目名称 |
|
||
| parentId | integer | 上级科目ID |
|
||
| ledgerType | string | 科目类型 |
|
||
| balanceDirection | string | 余额方向(DEBIT/CREDIT) |
|
||
| isLeaf | string | 是否末级 |
|
||
| enableFlag | string | 启用状态 |
|
||
|
||
##### 新增科目
|
||
|
||
```
|
||
POST /fd/ledger
|
||
```
|
||
|
||
##### 修改科目
|
||
|
||
```
|
||
PUT /fd/ledger
|
||
```
|
||
|
||
##### 删除科目
|
||
|
||
```
|
||
DELETE /fd/ledger/{ledgerIds}
|
||
```
|
||
|
||
#### 科目明细接口
|
||
|
||
##### 查询科目明细
|
||
|
||
```
|
||
GET /fd/subledger
|
||
```
|
||
|
||
**响应数据模型: FdSubledger**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| subledgerId | integer | 明细ID |
|
||
| ledgerId | integer | 科目ID |
|
||
| periodId | integer | 期间ID |
|
||
| debitAmount | number | 借方金额 |
|
||
| creditAmount | number | 贷方金额 |
|
||
| balance | number | 余额 |
|
||
|
||
#### 科目期初接口
|
||
|
||
##### 查询科目期初余额
|
||
|
||
```
|
||
GET /fd/sortinitial
|
||
```
|
||
|
||
**响应数据模型: FdSortInitial**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| initialId | integer | 期初ID |
|
||
| ledgerId | integer | 科目ID |
|
||
| periodId | integer | 期间ID |
|
||
| beginBalance | number | 期初余额 |
|
||
|
||
##### 设置科目期初
|
||
|
||
```
|
||
POST /fd/sortinitial
|
||
```
|
||
|
||
#### 凭证管理接口
|
||
|
||
##### 查询凭证列表
|
||
|
||
```
|
||
GET /fd/voucher
|
||
```
|
||
|
||
**响应数据模型: FdVoucherMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| voucherId | integer | 凭证ID |
|
||
| voucherCode | string | 凭证编号 |
|
||
| voucherDate | string | 凭证日期 |
|
||
| periodId | integer | 期间ID |
|
||
| voucherType | string | 凭证类型 |
|
||
| totalDebit | number | 借方合计 |
|
||
| totalCredit | number | 贷方合计 |
|
||
| status | string | 状态 |
|
||
| preparer | string | 制单人 |
|
||
| reviewer | string | 审核人 |
|
||
|
||
**凭证明细: FdVoucherSalve**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| lineId | integer | 行ID |
|
||
| voucherId | integer | 凭证ID |
|
||
| ledgerId | integer | 科目ID |
|
||
| ledgerCode | string | 科目编码 |
|
||
| ledgerName | string | 科目名称 |
|
||
| summary | string | 摘要 |
|
||
| debitAmount | number | 借方金额 |
|
||
| creditAmount | number | 贷方金额 |
|
||
|
||
##### 新增凭证
|
||
|
||
```
|
||
POST /fd/voucher
|
||
```
|
||
|
||
**请求体示例**
|
||
|
||
```json
|
||
{
|
||
"voucherDate": "2026-01-25",
|
||
"periodId": 1,
|
||
"voucherType": "记账凭证",
|
||
"lines": [
|
||
{
|
||
"ledgerId": 1001,
|
||
"summary": "采购原材料",
|
||
"debitAmount": 10000,
|
||
"creditAmount": 0
|
||
},
|
||
{
|
||
"ledgerId": 2001,
|
||
"summary": "采购原材料",
|
||
"debitAmount": 0,
|
||
"creditAmount": 10000
|
||
}
|
||
]
|
||
}
|
||
```
|
||
|
||
##### 修改凭证
|
||
|
||
```
|
||
PUT /fd/voucher
|
||
```
|
||
|
||
##### 删除凭证
|
||
|
||
```
|
||
DELETE /fd/voucher/{voucherIds}
|
||
```
|
||
|
||
##### 审核凭证
|
||
|
||
```
|
||
POST /fd/voucher/review/{voucherId}
|
||
```
|
||
|
||
##### 反审核凭证
|
||
|
||
```
|
||
POST /fd/voucher/unreview/{voucherId}
|
||
```
|
||
|
||
#### 日记帐接口
|
||
|
||
##### 查询日记帐列表
|
||
|
||
```
|
||
GET /fd/journal
|
||
```
|
||
|
||
**响应数据模型: FdJournal**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| journalId | integer | 日记帐ID |
|
||
| journalDate | string | 日期 |
|
||
| ledgerId | integer | 科目ID |
|
||
| voucherId | integer | 凭证ID |
|
||
| summary | string | 摘要 |
|
||
| debitAmount | number | 借方金额 |
|
||
| creditAmount | number | 贷方金额 |
|
||
| balance | number | 余额 |
|
||
|
||
#### 应收账款接口
|
||
|
||
##### 查询应收账款列表
|
||
|
||
```
|
||
GET /fd/receivable
|
||
```
|
||
|
||
**响应数据模型: FdReceivableMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| receivableId | integer | 应收ID |
|
||
| receivableCode | string | 应收单号 |
|
||
| clientId | integer | 客户ID |
|
||
| clientName | string | 客户名称 |
|
||
| receivableDate | string | 应收日期 |
|
||
| dueDate | string | 到期日 |
|
||
| totalAmount | number | 应收总额 |
|
||
| receivedAmount | number | 已收金额 |
|
||
| balanceAmount | number | 余额 |
|
||
| status | string | 状态 |
|
||
|
||
##### 新增应收账款
|
||
|
||
```
|
||
POST /fd/receivable
|
||
```
|
||
|
||
##### 修改应收账款
|
||
|
||
```
|
||
PUT /fd/receivable
|
||
```
|
||
|
||
#### 应收账款报表接口
|
||
|
||
##### 查询应收账款报表
|
||
|
||
```
|
||
GET /fd/arreport
|
||
```
|
||
|
||
**请求参数**
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
|--------|------|------|------|
|
||
| clientId | integer | 否 | 客户ID |
|
||
| periodId | integer | 否 | 期间ID |
|
||
| startDate | string | 否 | 开始日期 |
|
||
| endDate | string | 否 | 结束日期 |
|
||
|
||
#### 应付账款接口
|
||
|
||
##### 查询应付账款列表
|
||
|
||
```
|
||
GET /fd/payable
|
||
```
|
||
|
||
**响应数据模型: FdPayableMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| payableId | integer | 应付ID |
|
||
| payableCode | string | 应付单号 |
|
||
| vendorId | integer | 供应商ID |
|
||
| vendorName | string | 供应商名称 |
|
||
| payableDate | string | 应付日期 |
|
||
| dueDate | string | 到期日 |
|
||
| totalAmount | number | 应付总额 |
|
||
| paidAmount | number | 已付金额 |
|
||
| balanceAmount | number | 余额 |
|
||
| status | string | 状态 |
|
||
|
||
##### 新增应付账款
|
||
|
||
```
|
||
POST /fd/payable
|
||
```
|
||
|
||
##### 修改应付账款
|
||
|
||
```
|
||
PUT /fd/payable
|
||
```
|
||
|
||
#### 应付账款报表接口
|
||
|
||
##### 查询应付账款报表
|
||
|
||
```
|
||
GET /fd/apreport
|
||
```
|
||
|
||
#### 收款单接口
|
||
|
||
##### 查询收款单列表
|
||
|
||
```
|
||
GET /fd/receipt
|
||
```
|
||
|
||
**响应数据模型: FdReceiptMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| receiptId | integer | 收款单ID |
|
||
| receiptCode | string | 收款单号 |
|
||
| clientId | integer | 客户ID |
|
||
| clientName | string | 客户名称 |
|
||
| receiptDate | string | 收款日期 |
|
||
| receiptAmount | number | 收款金额 |
|
||
| paymentMethod | string | 收款方式 |
|
||
| status | string | 状态 |
|
||
|
||
##### 新增收款单
|
||
|
||
```
|
||
POST /fd/receipt
|
||
```
|
||
|
||
##### 修改收款单
|
||
|
||
```
|
||
PUT /fd/receipt
|
||
```
|
||
|
||
##### 删除收款单
|
||
|
||
```
|
||
DELETE /fd/receipt/{receiptIds}
|
||
```
|
||
|
||
#### 付款单接口
|
||
|
||
##### 查询付款单列表
|
||
|
||
```
|
||
GET /fd/payment
|
||
```
|
||
|
||
**响应数据模型: FdPaymentMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| paymentId | integer | 付款单ID |
|
||
| paymentCode | string | 付款单号 |
|
||
| vendorId | integer | 供应商ID |
|
||
| vendorName | string | 供应商名称 |
|
||
| paymentDate | string | 付款日期 |
|
||
| paymentAmount | number | 付款金额 |
|
||
| paymentMethod | string | 付款方式 |
|
||
| status | string | 状态 |
|
||
|
||
##### 新增付款单
|
||
|
||
```
|
||
POST /fd/payment
|
||
```
|
||
|
||
##### 修改付款单
|
||
|
||
```
|
||
PUT /fd/payment
|
||
```
|
||
|
||
##### 删除付款单
|
||
|
||
```
|
||
DELETE /fd/payment/{paymentIds}
|
||
```
|
||
|
||
#### 成本核算接口
|
||
|
||
##### 查询成本核算列表
|
||
|
||
```
|
||
GET /fd/cost
|
||
```
|
||
|
||
**响应数据模型: FdCostMaster**
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| costId | integer | 成本ID |
|
||
| costCode | string | 成本单号 |
|
||
| periodId | integer | 期间ID |
|
||
| itemId | integer | 产品ID |
|
||
| itemCode | string | 产品编码 |
|
||
| quantity | number | 数量 |
|
||
| materialCost | number | 材料成本 |
|
||
| laborCost | number | 人工成本 |
|
||
| overheadCost | number | 制造费用 |
|
||
| totalCost | number | 总成本 |
|
||
| unitCost | number | 单位成本 |
|
||
|
||
##### 运行成本核算
|
||
|
||
```
|
||
POST /fd/cost/run/{periodId}
|
||
```
|
||
|
||
#### 财务报表接口
|
||
|
||
##### 查询资产负债表
|
||
|
||
```
|
||
GET /fd/statement/balance
|
||
```
|
||
|
||
##### 查询利润表
|
||
|
||
```
|
||
GET /fd/statement/income
|
||
```
|
||
|
||
##### 查询现金流量表
|
||
|
||
```
|
||
GET /fd/statement/cashflow
|
||
```
|
||
|
||
---
|
||
|
||
## 数据模型定义
|
||
|
||
### 通用响应模型
|
||
|
||
#### TableDataInfo
|
||
|
||
分页查询响应模型
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| total | integer | 总记录数 |
|
||
| rows | array | 数据列表 |
|
||
| code | integer | 状态码 |
|
||
| msg | string | 消息 |
|
||
|
||
#### AjaxResult
|
||
|
||
通用响应模型
|
||
|
||
| 字段名 | 类型 | 说明 |
|
||
|--------|------|------|
|
||
| code | integer | 状态码 |
|
||
| msg | string | 消息 |
|
||
| data | object | 数据 |
|
||
|
||
### 状态码说明
|
||
|
||
| 状态码 | 说明 |
|
||
|--------|------|
|
||
| 200 | 成功 |
|
||
| 401 | 未授权 |
|
||
| 403 | 禁止访问 |
|
||
| 404 | 资源不存在 |
|
||
| 500 | 服务器内部错误 |
|
||
|
||
### 通用状态值
|
||
|
||
#### 单据状态
|
||
|
||
| 状态值 | 说明 |
|
||
|--------|------|
|
||
| DRAFT | 草稿 |
|
||
| SUBMITTED | 已提交 |
|
||
| APPROVED | 已审批 |
|
||
| REJECTED | 已驳回 |
|
||
| CLOSED | 已关闭 |
|
||
| CANCELLED | 已取消 |
|
||
|
||
#### 启用状态
|
||
|
||
| 状态值 | 说明 |
|
||
|--------|------|
|
||
| Y | 启用 |
|
||
| N | 停用 |
|
||
|
||
---
|
||
|
||
## 附录
|
||
|
||
### 模块接口路径汇总
|
||
|
||
| 模块 | 路径前缀 | 说明 |
|
||
|------|----------|------|
|
||
| 仓库模块 | /wm | Warehouse Management |
|
||
| 销售模块 | /sl | Sales |
|
||
| 计划模块 | /pl | Planning |
|
||
| 采购模块 | /po | Procurement |
|
||
| 生产模块 | /pd | Production |
|
||
| 物料模块 | /md | Master Data |
|
||
| 研发模块 | /rd | Research & Development |
|
||
| 委外模块 | /pu | Outsourcing |
|
||
| 财务模块 | /fd | Finance |
|
||
|
||
### 未采集模块说明
|
||
|
||
以下系统模块由于访问限制未能采集：
|
||
|
||
- 系统管理 (/system)
|
||
- 系统接口 (/api)
|
||
- 系统监控 (/monitor)
|
||
- 系统工具 (/tool)
|
||
|
||
---
|
||
|
||
**文档结束**
|