订单管理接口
1. 获取采购订单列表
请求地址
text
GET /Purchase/Order参数说明
采购订单查询接口支持丰富的条件过滤参数,请参见支持的查询参数附录
返回结果
json
{
"offset": 0,
"total": 13,
"results": [
{
"id": "52c8fe76-f0f7-488c-a88b-d95aa484f0c9",
"serialNo": "PAO202109030002",
"purchasePlatform": 1,
"companyId": 53291,
"companyCode": "AB",
"companyName": "易点易动",
"orderBy": 53763,
"orderUserName": "霍龙",
"orderTime": "1630661317",
"expectedTimeArrival": "1630661317",
"receiveAddress": "5楼仓库",
"vendorId": "4e0024ac-8c9f-4946-bc77-de6a1e4801e0",
"vendorName": "苏宁易购",
"comment": "下的订单",
"status": 1,
"paidAmount": 0.0000,
"totalAmount": 10019.0000,
"arrivalAmount": 0,
"details": [
{
"id": "14fddba8-7427-49fb-a7ab-61c6d385a997",
"orderId": "52c8fe76-f0f7-488c-a88b-d95aa484f0c9",
"skuId": 39596,
"skuCode": "11Pro",
"skuName": "小米11",
"specs": "11Pro",
"measureUnit": "台",
"skuType": 1,
"assetTypeCode": "01010102",
"assetTemplateName": "小米11",
"displayIndex": 1,
"quantity": 1.00,
"amount": 9999.0000,
"closedQuantity": 0.00,
"closedAmount": 0.00000000000,
"taxRate": 13,
"noTaxAmount": 8848.6700,
"price": 9999.00,
"arrivalQuantity": 0.00,
"arrivalAmount": 0,
"status": 1,
"allocations": [
{
"orderDetailId": "14fddba8-7427-49fb-a7ab-61c6d385a997",
"applicationDetailId": "6a24d234-c576-4e11-ab28-2e0f3ac9e7ce",
"applicationId": "1ac1ade2-3fe9-4452-85c5-ba555755288e",
"skuId": 0,
"applicationSerialNo": "PAA202109030001",
"applicationCompanyCode": "AB",
"applicationCompayName": "易点易动",
"appliedQuantity": 2.00,
"orderQuantity": 1.00,
"arrivalQuantity": 0.00,
"totalPurchasedQuantity": 0.00
}
]
},
{
"id": "3e09bfff-53b0-4285-80b4-9ca856daf8c0",
"orderId": "52c8fe76-f0f7-488c-a88b-d95aa484f0c9",
"skuId": 96533,
"skuCode": "0001",
"skuName": "铝塑板",
"specs": "Y43",
"measureUnit": "张",
"skuType": 2,
"assetTypeCode": "",
"assetTemplateName": "",
"displayIndex": 2,
"quantity": 1.00,
"amount": 20.0000,
"closedQuantity": 0.00,
"closedAmount": 0.00000000000,
"taxRate": 13,
"noTaxAmount": 17.7000,
"price": 20.00,
"arrivalQuantity": 0.00,
"arrivalAmount": 0,
"status": 1,
"allocations": [
{
"orderDetailId": "3e09bfff-53b0-4285-80b4-9ca856daf8c0",
"applicationDetailId": "4d09b962-342f-48c3-a584-898f078b4289",
"applicationId": "1ac1ade2-3fe9-4452-85c5-ba555755288e",
"skuId": 0,
"applicationSerialNo": "PAA202109030001",
"applicationCompanyCode": "AB",
"applicationCompayName": "易点易动",
"appliedQuantity": 10.00,
"orderQuantity": 1.00,
"arrivalQuantity": 0.00,
"totalPurchasedQuantity": 0.00
}
]
}
],
"attachments": []
}
],
"meta": {}
}| 参数 | 说明 |
|---|---|
| offset | 当前结果对于首条结果的偏移量,指定分页查询时不为0 |
| total | 所有符合查询条件的查询结果数量,指定需要结果记录数量时不为0 |
| results | 符合查询条件的采购订单详情集合 |
| meta | 其他信息 |
2. 新增采购订单
请求地址
text
POST /Purchase/Order请求示例
json
{
"purchasePlatform": 1,
"companyCode": "AB",
"orderTime": "1630661317",
"vendorId": "4e0024ac-8c9f-4946-bc77-de6a1e4801e0",
"receiveAddress": "5楼仓库",
"expectedTimeArrival": "1630661317",
"comment": "下的订单",
"details": [
{
"skuCode": "11Pro",
"skuType": 1,
"assetTemplateName": "小米11",
"assetTypeCode": "01010102",
"displayIndex": 1,
"quantity": 1,
"amount": 9999,
"taxRate": 13,
"noTaxAmount": 8848.67,
"Allocations": [
{
"applicationDetailId": "6a24d234-c576-4e11-ab28-2e0f3ac9e7ce",
"orderQuantity": 1,
"arrivalQuantity": 0
}
]
},
{
"skuCode": "0001",
"skuType": 2,
"assetTemplateName": "铝塑板",
"assetTypeCode": "",
"displayIndex": 2,
"quantity": 1,
"amount": 20,
"taxRate": 13,
"noTaxAmount": 17.7,
"Allocations": [
{
"applicationDetailId": "4d09b962-342f-48c3-a584-898f078b4289",
"orderQuantity": 1,
"arrivalQuantity": 0
}
]
}
]
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| purchasePlatform | 是 | 采购平台(暂时无用,默认传1) |
| companyCode | 是 | 采购公司编码 |
| orderTime | 是 | 订购时间(时间戳格式) |
| vendorId | 否 | 供应商id |
| receiveAddress | 否 | 收货信息 |
| expectedTimeArrival | 否 | 预计到货日期(时间戳格式) |
| comment | 是 | 申请说明 |
| status | 否 | 该字段不传值或传1为保存单据(草稿状态的订单)、传2为保存并提交单据(已提交的订单) |
| details | 是 | 要采购的物品详情 |
物品详情
| 参数 | 是否必须 | 说明 |
|---|---|---|
| skuCode | 是 | 物品编码 |
| skuType | 是 | 物品类型(1:资产、2:耗材) |
| assetTemplateName | 是 | 物品名称 |
| assetTypeCode | 否 | 资产分类编码(如果物品类型为资产,则该项必填) |
| displayIndex | 是 | 显示的行号(物品的序列号) |
| quantity | 是 | 采购数量 |
| amount | 是 | 金额 |
| taxRate | 是 | 税率 |
| noTaxAmount | 是 | 不含税金额 |
| Allocations | 否 | 物品的关联信息(可以在设置-通用设置中取消“必须根据申请创建采购订单”的勾选,设置完成后可以不上传关联的申请单的信息) |
物品的关联信息
| 参数 | 是否必须 | 说明 |
|---|---|---|
| applicationDetailId | 是 | 申请单子表id |
| orderQuantity | 是 | 订单数量 |
| arrivalQuantity | 是 | 到货数量,传0即可 |
返回结果
json
{
"id":"52c8fe76-f0f7-488c-a88b-d95aa484f0c9",
"serialNo":"PAO202109030002"
}结果说明
| 属性名称 | 说明 |
|---|---|
| id | 采购订单id |
| serialNo | 采购订单号 |
3. 修改、提交采购订单
请求地址
text
POST /Purchase/Order/put请求示例
json
{
"purchasePlatform": 1,
"serialNo": "PAO202109030002",
"companyCode": "AB",
"orderTime": "1630661317",
"vendorId": "4e0024ac-8c9f-4946-bc77-de6a1e4801e0",
"receiveAddress": "5楼仓库",
"expectedTimeArrival": "1630920480",
"comment": "下的订单啊",
"details": [
{
"skuCode": "11Pro",
"skuType": 1,
"assetTemplateName": "小米11",
"assetTypeCode": "01010102",
"displayIndex": 1,
"quantity": 1,
"amount": 9999,
"taxRate": 13,
"noTaxAmount": 8848.67,
"Allocations": [
{
"applicationDetailId": "6a24d234-c576-4e11-ab28-2e0f3ac9e7ce",
"orderQuantity": 1
}
]
},
{
"skuCode": "0001",
"skuType": 2,
"assetTemplateName": "铝塑板",
"assetTypeCode": "",
"displayIndex": 2,
"quantity": 3,
"amount": 60,
"taxRate": 13,
"noTaxAmount": 53.1,
"Allocations": [
{
"applicationDetailId": "4d09b962-342f-48c3-a584-898f078b4289",
"orderQuantity": 3
}
]
}
],
"status": 1
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| purchasePlatform | 是 | 采购平台(暂时无用,默认传1) |
| serialNo | 是 | 采购单号 |
| companyCode | 是 | 采购公司编码 |
| orderTime | 是 | 订购时间(时间戳格式) |
| vendorId | 否 | 供应商id |
| receiveAddress | 否 | 收货信息 |
| expectedTimeArrival | 否 | 预计到货日期(时间戳格式) |
| comment | 是 | 申请说明 |
| status | 是 | 该字段传1为保存单据(草稿状态的订单)、传2为保存并提交单据(已提交的订单) |
| details | 是 | 要采购的物品详情 |
提交采购订单时status字段传2
物品详情
| 参数 | 是否必须 | 说明 |
|---|---|---|
| skuCode | 是 | 物品编码 |
| skuType | 是 | 物品类型(1:资产、2:耗材) |
| assetTemplateName | 是 | 物品名称 |
| assetTypeCode | 否 | 资产分类编码(如果物品类型为资产,则该项必填) |
| displayIndex | 是 | 显示的行号(物品的序列号) |
| quantity | 是 | 采购数量 |
| amount | 是 | 金额 |
| taxRate | 是 | 税率 |
| noTaxAmount | 是 | 不含税金额 |
| Allocations | 否 | 物品的关联信息(可以在设置-通用设置中取消“必须根据申请创建采购订单”的勾选,设置完成后可以不上传关联的申请单的信息) |
物品的关联信息
| 参数 | 是否必须 | 说明 |
|---|---|---|
| applicationDetailId | 是 | 申请单子表id |
| orderQuantity | 是 | 订单数量 |
返回结果
json
{
"id":"1ac1ade2-3fe9-4452-85c5-ba555755288e",
"serialNo":"PAA202109030001"
}结果说明
| 属性名称 | 说明 |
|---|---|
| id | 采购订单id |
| serialNo | 采购订单号 |
4. 删除采购订单
请求地址
text
POST /Purchase/Order/delete请求示例
json
{
"serialNo": "PAO202109060003"
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| serialNo | 是 | 采购订单号 |
返回结果
json
{}对于成功删除的请求,该接口仅返回HTTP 200 OK
5. 关闭采购订单
请求地址
text
POST /Purchase/Order/status/put请求示例
json
{
"serialNo": "PAO202109060003"
}参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| serialNo | 是 | 采购订单号 |
返回结果
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. 采购订单数据对象格式
| 属性名称 | 说明 |
|---|---|
| id | 采购订单id |
| serialNo | 采购订单号 |
| purchasePlatform | 申请公司id |
| companyId | 采购公司id |
| companyCode | 采购公司编码 |
| companyName | 采购公司名称 |
| orderBy | 采购员Id |
| orderUserName | 采购员名称 |
| orderTime | 采购时间(时间戳格式) |
| expectedTimeArrival | 预计到货日期(时间戳格式) |
| receiveAddress | 收货信息 |
| vendorId | 供应商id |
| vendorName | 供应商名称 |
| comment | 订单说明 |
| status | 订单状态(1:草稿、2:已提交、3:已审批、4:已驳回、5:已完成) |
| paidAmount | 已支付金额 |
| totalAmount | 订单总金额 |
| arrivalAmount | 到货金额 |
| details | 采购订单包含的物品详情集合 |
| attachments | 附件信息(请从pc端操作附件) |
采购订单包含的物品详情
| 属性名称 | 说明 |
|---|---|
| id | 子表id |
| orderId | 关联的采购订单Id |
| skuId | 物品id(资产或耗材的原id) |
| skuName | 物品名称 |
| skuCode | 物品编码 |
| measureUnit | 物品计量单位 |
| specs | 物品规格型号 |
| skuType | 物品类型(1:资产、2:耗材) |
| assetTypeCode | 资产分类编码 |
| assetTemplateName | 资产标准名称 |
| displayIndex | 显示的行号(物品的序列号) |
| quantity | 采购数量 |
| amount | 采购金额 |
| closedQuantity | 已关闭数量 |
| closedAmount | 已关闭金额 |
| taxRate | 税率 |
| noTaxAmount | 不含税金额 |
| price | 采购单价 |
| arrivalQuantity | 到货数量 |
| arrivalAmount | 到货金额 |
| status | 物品状态(1:草稿、2:已提交、3:已审批、4:已驳回、5:已关闭、6:已完成) |
| allocations | 物品的关联信息 |
物品的关联信息
| 属性名称 | 说明 |
|---|---|
| orderDetailId | 订单子表id |
| applicationDetailId | 采购申请单子表id |
| applicationId | 采购申请单id |
| skuId | 物品id(无用) |
| applicationSerialNo | 采购申请单号 |
| applicationCompanyCode | 申请公司编码 |
| applicationCompayName | 申请公司名称 |
| appliedQuantity | 申请数量 |
| orderQuantity | 订货数量 |
| arrivalQuantity | 到货数量 |
| totalPurchasedQuantity | 已购买数量 |