出库单接口
1. 获取耗材出库申请单列表
请求地址
text
GET /application/consumable参数说明
耗材出库申请单查询接口支持丰富的条件过滤参数,请参见支持的查询参数附录
返回结果
json
{
"offset": 0,
"total": 0,
"results": [
{
"receiveEmployeeName": "张三",
"companyName": "测试企业",
"companyCode": "01",
"departmentCode": "1001",
"departmentName": "测试部门",
"applyEmployeeName": "张三",
"products": [
{
"categoryID": 36361,
"code": "10010101",
"name": "铅笔",
"commodityCode": "10010101",
"specs": "",
"measureUnit": "",
"remark": "",
"picPath": "/UploadImage/c5509207-eeae-4002-8d7e-d8c565a644a4.jpg",
"smallPicPath": "/UploadImage/a3f8c0db-d2bf-4677-8b0e-1b362caf19ba.jpg",
"batchID": 2,
"categoryName": "物品分类",
"categoryCode": "sys001",
"id": "7f978bae-bd13-4b99-844c-970cf1c5e4a3",
"applicationId": "40f0de1c-40a9-4d78-bfbe-01d4ad86b684",
"applyTime": "1565166826",
"productId": 63831,
"applyQuantity": 2,
"approveQuantity": 2,
"unitPrice": 1.5,
"amount": 3,
"status": 0,
"issueQuantity": 0
}
],
"applyEmployeeNo": "100001",
"receiveEmployeeNo": "100001",
"receiptCount": 0,
"pendingReceiptCount": 0,
"needApprove": true,
"approveId": "ba76b773-5e7b-41bf-b457-1b9c80fd9cdb",
"applyCount": 1,
"id": "40f0de1c-40a9-4d78-bfbe-01d4ad86b684",
"serialNo": "CONS201908070001",
"receiveEmployeeId": "ea6acdeb-d0ed-4de5-b4b8-070395ef2f3f",
"companyId": 45448,
"departmentId": 243533,
"applyEmployeeId": "ea6acdeb-d0ed-4de5-b4b8-070395ef2f3f",
"applyTime": "1565166826",
"applyRemark": "",
"status": 9
}
],
"meta": {}
}| 参数 | 说明 |
|---|---|
| offset | 当前结果对于首条结果的偏移量,指定分页查询时不为0 |
| total | 所有符合查询条件的查询结果数量,指定需要结果记录数量时不为0 |
| results | 符合查询条件的耗材出库申请单详情集合 |
| meta | 其他信息 |
2. 获取耗材出库单、退库单列表
请求地址
text
GET /consumable/outStorage请求实例
text
/consumable/outStorage?skip=0&take=20&include=total&FilterByPermission=1参数说明
资耗材出库申请单查询接口支持丰富的条件过滤参数,请参见支持的查询参数附录
返回结果
json
{
"offset": 0,
"total": 0,
"results": [
{
"companyCode": "01",
"departmentCode": "1001",
"userEmployeeNo": "100001",
"employeeName": "阿敏",
"warehouseCode": "1001",
"consumables": [
{
"serialNo": "CRE202008210001",
"batchNo": "",
"consumableId": 118228,
"enterpriseId": 4506,
"code": "2132122",
"name": "名称",
"picturePath": "/MediaResources/4506/Consumable/20200821/dbd0e90b9aca42cda5a73cf489dce90a.jpg",
"thumbnailPath": "/MediaResources/4506/Consumable/20200821/102a6249e7184cd6a4d764771b6147e4.jpg",
"quantity": 10.00,
"unitPrice": 1.0000,
"amount": 10.0000,
"safeStockUpperLimit": 0,
"safeStockLowerLimit": 0
}
],
"applicationSerialNo": "CONS201907270004",
"enterpriseId": 4506,
"serialNo": "CRE202008210001",
"outType": 0,
"warehouseId": 10181,
"warehouseName": "石家庄仓",
"handleTime": "1597968000",
"companyId": 7024,
"companyName": "恶魔",
"departmentId": 13759,
"departmentName": "测试吧",
"receiveByName": "阿敏",
"createdTime": "1598006131",
"createdBy": 6261,
"createdByName": "尚德",
"remark": "啊啊啊",
"updatedTime": "1598006140",
"updatedBy": 6261,
"updatedByName": "尚德",
"signatureStatus": 1,
"signaturePicturePath": "/MediaResources/4506/Signature/20200821/d6127904a8f74a859c532b2404933529.jpg",
"signatureDate": "1598006147",
"userEmployeeId": "dbb5aa65-8f1c-4d69-8366-49823fe978a3",
"issueStatus": 0,
"needEmployeeSign": false,
"forceComplete": false
}
],
"meta": {}
}| 参数 | 说明 |
|---|---|
| offset | 当前结果对于首条结果的偏移量,指定分页查询时不为0 |
| total | 所有符合查询条件的查询结果数量,指定需要结果记录数量时不为0 |
| results | 符合查询条件的耗材出库、退库单详情集合 |
| meta | 其他信息 |
3. 新增耗材出库单
请求地址
text
POST /consumable/outStorage请求示例
json
{
"CompanyCode":"01",
"HandleTime":"1601395200",
"WarehouseCode":"1001",
"UserEmployeeNo":"563333",
"OutType":"0",
"DepartmentCode":"64672",
"Remark":"出库",
"Products":[
{
"Code":"26886859",
"Remark":"消耗快",
"Amount":"9.0",
"Quantity":"3",
"BatchNo":""
}
]
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| applicationNo | 否 | 申请单号 |
| OutType | 是 | 单据类型(0:出库单、1:冲销单) |
| UserEmployeeNo | 是 | 领用人编码 |
| WarehouseCode | 是 | 仓库编码 |
| HandleTime | 是 | 业务日期(时间戳格式) |
| CompanyCode | 是 | 领用公司编码 |
| DepartmentCode | 是 | 领用部门编码 |
| Remark | 否 | 备注 |
| Products | 是 | 新增耗材出库单的物品详情集合 |
新增耗材出库单的物品详情
| 参数 | 是否必须 | 说明 |
|---|---|---|
| Code | 是 | 物品编码 |
| BatchNo | 否 | 批次 |
| Quantity | 是 | 数量 |
| Amount | 是 | 金额 |
| Remark | 否 | 备注 |
附加信息
applicationNo:通过申请单创建的发放单必须填写申请单号。
返回结果
json
{
"serialNo": "CRE202009300001",
"signatureId": 341430,
"safetyStockReminder": ""
}结果说明
| 属性名称 | 说明 |
|---|---|
| serialNo | 单据号 |
| signatureId | 签字Id |
| safetyStockReminder | 安全库存报警 |
4. 修改耗材出库单
请求地址
text
PUT /consumable/outStorage/{serialNo}
POST /consumable/outStorage/{serialNo}/put对于不支持PUT请求的网络环境,请尝试使用备份的POST请求地址
请求示例
json
{
"CompanyCode":"01",
"HandleTime":"1601395200",
"WarehouseCode":"1001",
"UserEmployeeNo":"563333",
"DepartmentCode":"64672",
"Remark":"出库",
"Products":[
{
"Code":"26886859",
"Remark":"消耗快",
"Amount":"9.0",
"Quantity":"3",
"BatchNo":""
}
]
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| applicationNo | 否 | 申请单号 |
| UserEmployeeNo | 是 | 领用人编码 |
| WarehouseCode | 是 | 仓库编码 |
| HandleTime | 是 | 业务日期(时间戳格式) |
| CompanyCode | 是 | 领用公司编码 |
| DepartmentCode | 是 | 领用部门编码 |
| Remark | 否 | 备注 |
| products | 是 | 修改耗材出库单的物品详情集合 |
附加信息
applicationNo:通过申请单创建的发放单必须填写申请单号。
返回结果
json
{
"serialNo": "CRE202009300001",
"signatureId": 341430,
"safetyStockReminder": ""
}结果说明
| 属性名称 | 说明 |
|---|---|
| serialNo | 单据号 |
| signatureId | 签字Id |
| safetyStockReminder | 安全库存报警 |
5. 删除耗材出库单
请求地址
text
DELETE /consumable/outStorage/{serialNo}
POST /consumable/outStorage/{serialNo}/delete对于不支持DELETE请求的网络环境,请尝试使用备份的POST请求地址
返回结果
json
{}对于成功删除的请求,该接口仅返回HTTP 200 OK
6. 新增耗材退库单
请求地址
text
POST /consumable/antiOutStorage请求示例
json
{
"CompanyCode":"01",
"HandleTime":"1601395200",
"WarehouseCode":"1001",
"UserEmployeeNo":"563333",
"OutType":"1",
"DepartmentCode":"64672",
"Remark":"退库",
"Products":[
{
"Code":"26886859",
"Remark":"消耗快",
"Amount":"9.0",
"Quantity":"3",
"BatchNo":""
}
]
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| OutType | 是 | 单据类型(0:出库单、1:冲销单) |
| UserEmployeeNo | 是 | 退库人编码 |
| WarehouseCode | 是 | 仓库编码 |
| HandleTime | 是 | 业务日期(时间戳格式) |
| CompanyCode | 是 | 退库公司编码 |
| DepartmentCode | 是 | 退库部门编码 |
| Remark | 否 | 备注 |
| Products | 是 | 新增耗材退库单的物品详情集合 |
返回结果
json
{
"serialNo": "CRT202009300001",
"signatureId": 341430,
"safetyStockReminder": ""
}结果说明
| 属性名称 | 说明 |
|---|---|
| serialNo | 单据号 |
| signatureId | 签字Id |
| safetyStockReminder | 安全库存报警 |
7. 修改耗材退库单
请求地址
text
PUT /consumable/antiOutStorage/{serialNo}
POST /consumable/antiOutStorage/{serialNo}/put对于不支持PUT请求的网络环境,请尝试使用备份的POST请求地址
请求示例
json
{
"CompanyCode":"01",
"HandleTime":"1601395200",
"WarehouseCode":"1001",
"UserEmployeeNo":"563333",
"DepartmentCode":"64672",
"Remark":"退库",
"Products":[
{
"Code":"26886859",
"Remark":"消耗快",
"Amount":"9.0",
"Quantity":"3",
"BatchNo":""
}
]
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| UserEmployeeNo | 是 | 退库人编码 |
| WarehouseCode | 是 | 仓库编码 |
| HandleTime | 是 | 业务日期(时间戳格式) |
| CompanyCode | 是 | 退库公司编码 |
| DepartmentCode | 是 | 退库部门编码 |
| Remark | 否 | 备注 |
| products | 是 | 修改耗材退库单的物品详情集合 |
返回结果
json
{
"serialNo": "CRE202009300001",
"signatureId": 341430,
"safetyStockReminder": ""
}结果说明
| 属性名称 | 说明 |
|---|---|
| serialNo | 单据号 |
| signatureId | 签字Id |
| safetyStockReminder | 安全库存报警 |
8. 删除耗材退库单
请求地址
text
DELETE /consumable/antiOutStorage/{serialNo}
POST /consumable/antiOutStorage/{serialNo}/delete对于不支持DELETE请求的网络环境,请尝试使用备份的POST请求地址
返回结果
json
{}对于成功删除的请求,该接口仅返回HTTP 200 OK
附录
1. 支持的查询参数
如无特别说明,下列操作对于查询实体对象中的任意属性均适用。使用时只需将其追加至请求的querystring中即可。对实体对象中不存在的属性进行操作将会得到不可预期的结果。
分页
skip={数字} 跳过指定条数的记录数
take={数字} 取出指定条数的记录数(注:最大值为1500,即单页最多返回1500条数据)
include=total 需要返回记录总数
排序
orderBy=[-]{属性名称},[-]{属性名称} 返回结果按指定属性排序,在名称前加”-“表示按倒序排序。多个属性的排序可使用逗号分隔。如:orderBy=-Id,Name,-Age
条件过滤
不等于
{属性名称}!={值} 如:Id!=1
大于等于
>{属性名称}={值} 如:>Id=1
大于
{属性名称}>={值} 如:Id>=1
小于
<{属性名称}={值} 如:<Id=1
小于等于
{属性名称}<={值} 如:Id<=1
In
{属性名称}In={值,值,值} 属性的值需包含在指定的集合中,如:IdIn=1,2,3
Between
{属性名称}Between={值,值} 属性的值需处于指定的区间之间,仅支持数字,如: IdBetween=1,3
字符串包含指定字符
{属性名称}Contains={值} 如:nameContains=abc
字符串以指定字符开头
{属性名称}StartsWith={值} 如:nameStartsWith=abc
字符串以指定字符结尾
{属性名称}EndsWith={值} 如:nameEndsWith=abc
2. 数据实体格式
1. 耗材出库申请单数据对象格式
| 属性名称 | 说明 |
|---|---|
| companyCode | 申请公司编码 |
| companyName | 申请公司名称 |
| departmentCode | 申请部门编码 |
| departmentName | 申请部门名称 |
| applyEmployeeNo | 申请人编码 |
| applyEmployeeName | 申请人名称 |
| receiveEmployeeNo | 接收人编码 |
| receiveEmployeeName | 接收人名称 |
| applyCount | 申请数量 |
| receiptCount | 发放数量 |
| pendingReceiptCount | 待签字的发放数量 |
| needApprove | 是否审批,true:是、false:否 |
| approveId | 审批单Id |
| id | 申请单Id |
| serialNo | 申请单号 |
| receiveEmployeeId | 接收人Id |
| receiveTime | 接收时间(时间戳格式) |
| companyId | 申请公司Id |
| departmentId | 申请部门Id |
| applyEmployeeId | 申请人Id |
| applyTime | 申请时间(时间戳格式) |
| applyRemark | 申请备注 |
| status | 审批单状态,0:待审批、1:已同意、2:发放中、3:已发放、4:已完成、9:已驳回 |
| products | 申请单的物品详情集合 |
申请单的物品详情
| 属性名称 | 说明 |
|---|---|
| categoryID | 耗材分类Id |
| code | 耗材编码 |
| name | 耗材名称 |
| commodityCode | 商品码 |
| specs | 规格型号 |
| measureUnit | 计量单位 |
| remark | 备注 |
| picPath | 耗材图片路径 |
| smallPicPath | 耗材图片的缩略图路径 |
| batchID | 批次号 |
| categoryName | 耗材分类名称 |
| categoryCode | 耗材分类编码 |
| id | 申请单的子表Id |
| applicationId | 申请单Id |
| applyTime | 申请时间(时间戳格式) |
| productId | 物品Id |
| applyQuantity | 申请数量 |
| approveQuantity | 审批数量 |
| unitPrice | 单价 |
| amount | 金额 |
| issueQuantity | 发放数量 |
| status | 物品发放状态,0:未发放、1:已发放、2:已签收 |
2. 耗材出库、退库单数据对象格式
| 属性名称 | 说明 |
|---|---|
| companyCode | 领用公司编码 |
| departmentCode | 领用部门编码 |
| userEmployeeNo | 领用人编码 |
| employeeName | 领用人姓名 |
| warehouseCode | 仓库编码 |
| enterpriseId | 企业id |
| serialNo | 单据号 |
| outType | 单据类型(0:耗材出库单、1:耗材退库单) |
| warehouseId | 仓库id |
| warehouseName | 仓库名称 |
| handleTime | 经办日期(时间戳格式) |
| companyId | 领用公司id |
| companyName | 领用公司名称 |
| departmentId | 领用部门id |
| departmentName | 领用部门名称 |
| receiveByName | 领用人名称 |
| createdTime | 创建日期(时间戳格式) |
| createdBy | 创建人id |
| createdByName | 创建人 |
| remark | 备注 |
| updatedTime | 更新日期(时间戳格式) |
| updatedBy | 更新人id |
| updatedByName | 更新人 |
| signatureStatus | 签字状态,0:待签字、1:已签字、2:已打回、4:待审批、5:已审批、6:审批驳回、10:已审批待签字、11:已审批已签字、21:已审批签字驳回、3:空状态 |
| signaturePicturePath | 签字图片路径 |
| signatureDate | 签字日期 |
| userEmployeeId | 领用人id |
| issueStatus | 发放状态无用 |
| forceComplete | 是否强制完成 |
| applicationSerialNo | 申请单据号 |
| needEmployeeSign | 是否需要员工端签字,true:是、false:否 |
| dataJson | 单据扩展字段字符串合集 |
| consumables | 耗材出库、退库单包含的物品详情集合 |
耗材出库、退库单包含的物品详情
| 属性名称 | 说明 |
|---|---|
| serialNo | 物品所属单据号 |
| batchNo | 批次号 |
| consumableId | 物品id |
| enterpriseId | 企业id |
| code | 物品编码 |
| name | 物品名称 |
| picturePath | 物品图片路径 |
| thumbnailPath | 物品图片的缩略图路径 |
| barcode | 商品码 |
| specification | 规格型号 |
| measureUnit | 计量单位 |
| quantity | 出库数量 |
| unitPrice | 单价 |
| amount | 金额 |
| remark | 备注 |
| safeStockLowerLimit | 安全库存下限 |
| safeStockUpperLimit | 安全库存上限 |