收货管理接口

1. 获取收货管理单列表

请求地址

GET /Purchase/Receive

参数说明

收货管理单查询接口支持丰富的条件过滤参数，请参见支持的查询参数附录

返回结果

{
    "offset": 0,
    "total": 13,
    "results": [
        {
            "id": "dae7c8ba-5c06-43eb-b7fb-609acf8f0072",
            "serialNo": "PAR202109090001",
            "purchasePlatform": 1,
            "sourceType": 2,
            "companyId": 53291,
            "companyCode": "AB",
            "companyName": "易点易动",
            "receivedBy": 53763,
            "receivedUserName": "霍龙",
            "receivedTime": "1631175836",
            "vendorId": "4e0024ac-8c9f-4946-bc77-de6a1e4801e0",
            "vendorName": "苏宁易购",
            "comment": "订单说明: 下的订单啊",
            "status": 1,
            "details": [
                {
                    "id": "eb7950c1-c99f-41a7-b904-dca324089a56",
                    "receivedId": "dae7c8ba-5c06-43eb-b7fb-609acf8f0072",
                    "skuId": 39596,
                    "skuCode": "11Pro",
                    "skuName": "小米11",
                    "skuType": 1,
                    "specs": "11Pro",
                    "measureUnit": "台",
                    "assetTypeCode": "01010102",
                    "assetTemplateName": "小米11",
                    "displayIndex": 1,
                    "orderDetailId": "a8a9fb58-e277-4bbc-833f-2738a6f0d73a",
                    "orderSerialNo": "PAO202109030002",
                    "orderQuantity": 2.00,
                    "orderAmount": 20000.0000,
                    "price": 10000.00,
                    "amount": 10000.0000,
                    "taxRate": 13,
                    "noTaxAmount": 8849.5600,
                    "warehouseName": "",
                    "districtCode": "BJ",
                    "districtName": "北京",
                    "arrivalQuantity": 1.00,
                    "status": 1
                },
                {
                    "id": "03d10f44-5642-48ad-8a37-67d964bf3f15",
                    "receivedId": "dae7c8ba-5c06-43eb-b7fb-609acf8f0072",
                    "skuId": 96533,
                    "skuCode": "0001",
                    "skuName": "铝塑板",
                    "skuType": 2,
                    "specs": "Y43",
                    "measureUnit": "张",
                    "assetTypeCode": "",
                    "assetTemplateName": "",
                    "displayIndex": 2,
                    "orderDetailId": "56c58cda-e599-45a0-90ca-edaae7c9dcd1",
                    "orderSerialNo": "PAO202109030002",
                    "orderQuantity": 2.00,
                    "orderAmount": 40.0000,
                    "price": 20.00,
                    "amount": 20.0000,
                    "taxRate": 13,
                    "noTaxAmount": 17.7000,
                    "warehouseCode": "04",
                    "warehouseName": "第五配件仓库",
                    "districtName": "",
                    "arrivalQuantity": 1.00,
                    "status": 1
                }
            ],
            "attachments": []
        }
    ],
    "meta": {}
}

参数	说明
offset	当前结果对于首条结果的偏移量，指定分页查询时不为0
total	所有符合查询条件的查询结果数量，指定需要结果记录数量时不为0
results	符合查询条件的收货管理单详情集合
meta	其他信息

2. 新增收货管理单

请求地址

POST /Purchase/Receive

请求示例

{
  "companyCode": "AB",
  "receivedTime": "1631175836",
  "vendorId": "4e0024ac-8c9f-4946-bc77-de6a1e4801e0",
  "comment": "订单说明: 下的订单啊",
  "purchasePlatform": 1,
  "sourceType": 2,
  "sourceSerialNo": "PAO202109030002",
  "details": [
    {
      "skuCode": "11Pro",
      "skuType": 1,
      "assetTemplateName": "小米11",
      "assetTypeCode": "01010102",
      "displayIndex": 1,
      "quantity": 2,
      "orderDetailId": "a8a9fb58-e277-4bbc-833f-2738a6f0d73a",
      "arrivalQuantity": 1,
      "amount": 10000,
      "taxRate": 13,
      "noTaxAmount": 8849.56,
      "districtCode": "BJ"
    },
    {
      "skuCode": "0001",
      "skuType": 2,
      "assetTemplateName": "铝塑板",
      "assetTypeCode": "",
      "displayIndex": 2,
      "quantity": 2,
      "orderDetailId": "56c58cda-e599-45a0-90ca-edaae7c9dcd1",
      "arrivalQuantity": 1,
      "amount": 20,
      "taxRate": 13,
      "noTaxAmount": 17.7,
      "warehouseCode": "04"
    }
  ]
}

参数说明

参数	是否必须	说明
companyCode	是	收货公司编码
receivedTime	是	收货时间（时间戳格式）
vendorId	是	供应商
comment	否	收货说明
purchasePlatform	是	采购平台（暂无用，默认传1）
sourceType	是	收获单的来源类型（1:无关联采购订单、2:关联了采购订单）
sourceSerialNo	否	关联的采购订单号，如果在设置-通用设置中勾选上“允许无订单收货”，可以不填写采购订单
status	否	该字段传1或者不传值为保存单据（草稿状态的收货单）、传2为保存并提交单据（已提交的收货单）
details	是	要收货的物品详情

物品详情

参数	是否必须	说明
skuCode	是	物品编码
skuType	是	物品类型（1：资产、2:耗材）
assetTemplateName	是	物品名称
assetTypeCode	否	资产分类编码（如果物品是资产的话，该项为必填项）
displayIndex	是	显示的行号（物品的序列号）
quantity	否	订货数量
orderDetailId	否	采购订单子表id（如果关联了采购订单，该项为必填项）
arrivalQuantity	是	收货数量
amount	是	收货金额
taxRate	是	税率
noTaxAmount	是	不含税金额
districtCode	是	收货区域编码（如果物品是资产，该项为必填项）
warehouseCode	是	收货仓库编码（如果物品是耗材，该项为必填项）

返回结果

{   
    "id":"dae7c8ba-5c06-43eb-b7fb-609acf8f0072",
    "serialNo":"PAR202109090001"
}

结果说明

属性名称	说明
id	收货管理单id
serialNo	收货管理单号

3. 修改、提交收货单

请求地址

POST Purchase/Receive/put

请求示例

{
  "serialNo": "PAR202109090001",
  "companyCode": "AB",
  "receivedTime": "1631175836",
  "vendorId": "4e0024ac-8c9f-4946-bc77-de6a1e4801e0",
  "comment": "订单说明: 下的订单啊112",
  "purchasePlatform": 1,
  "sourceType": 2,
  "sourceSerialNo": "PAO202109030002",
  "details": [
    {
      "skuCode": "11Pro",
      "skuType": 1,
      "assetTemplateName": "小米11",
      "assetTypeCode": "01010102",
      "displayIndex": 1,
      "quantity": 2,
      "orderDetailId": "a8a9fb58-e277-4bbc-833f-2738a6f0d73a",
      "arrivalQuantity": 1,
      "amount": 10000,
      "taxRate": 13,
      "noTaxAmount": 8849.56,
      "districtCode": "BJ"
    },
    {
      "skuCode": "0001",
      "skuType": 2,
      "assetTemplateName": "铝塑板",
      "assetTypeCode": "",
      "displayIndex": 2,
      "quantity": 2,
      "orderDetailId": "56c58cda-e599-45a0-90ca-edaae7c9dcd1",
      "arrivalQuantity": 1,
      "amount": 20,
      "taxRate": 13,
      "noTaxAmount": 17.7,
      "warehouseCode": "04"
    }
  ],
  "status": 1
}

参数说明

参数	是否必须	说明
serialNo	是	变更单号
companyCode	是	收货公司编码
receivedTime	是	收货时间（时间戳格式）
vendorId	是	供应商
comment	否	收货说明
purchasePlatform	是	采购平台（暂无用，默认传1）
sourceType	是	收获单的来源类型（1:无关联采购订单、2:关联了采购订单）
sourceSerialNo	否	关联的采购订单号，如果在设置-通用设置中勾选上“允许无订单收货”，可以不填写采购订单
status	是	该字段传1为保存单据（草稿状态的收货单）、传2为保存并提交单据（已提交的收货单）
details	是	要收货的物品详情

提交收货管理单时status字段传2

物品详情

参数	是否必须	说明
skuCode	是	物品编码
skuType	是	物品类型（1：资产、2:耗材）
assetTemplateName	是	物品名称
assetTypeCode	否	资产分类编码（如果物品是资产的话，该项为必填项）
displayIndex	是	显示时的行号
quantity	否	订货数量
orderDetailId	否	采购订单子表id（如果关联了采购订单，该项为必填项）
arrivalQuantity	是	收货数量
amount	是	收货金额
taxRate	是	税率
noTaxAmount	是	不含税金额
districtCode	是	收货区域编码（如果物品是资产，该项为必填项）
warehouseCode	是	收货仓库编码（如果物品是耗材，该项为必填项）

返回结果

{   
    "id":"dae7c8ba-5c06-43eb-b7fb-609acf8f0072",
    "serialNo":"PAR202109090001"
}

结果说明

属性名称	说明
id	收货管理单id
serialNo	收货管理单号

4. 删除收货管理单

请求地址

POST /Purchase/Receive/delete

请求示例

{
    "serialNo": "PAR202109090002"
}

参数说明

参数	是否必须	说明
serialNo	是	收货管理单号

返回结果

{}

对于成功删除的请求，该接口仅返回HTTP 200 OK

5. 收货管理单入库

请求地址

GET /Purchase/Receive/{serialNo}/Warehousing

参数说明

参数	是否必须	说明
serialNo	是	收货单号

返回结果

[
    {
        "detailId": "beb9096d-6d9e-475d-b11a-8896b5b8edc0",
        "isSuccess": false,
        "message": "收货详情第2行创建耗材入库出错: 仓库已被盘点单锁定，不允许操作",
        "status": 1
    },
    {
        "detailId": "592b2bdb-8ca6-4791-a252-a3d76a7ddfdd",
        "isSuccess": true,
        "status": 2
    }
]

结果说明

属性名称	说明
detailId	收货单子表id
isSuccess	是否成功入库
message	错误消息
status	物品状态（1:待入库、2:入库中、3:已入库、4:已退货、5:已驳回）

附录

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	采购平台（暂时无用）
sourceType	收货单的来源类型（1:无关联采购订单、2:关联了采购订单）
companyId	收货公司id
companyCode	收货公司编码
companyName	收货公司名称
receivedBy	收货人Id
receivedUserName	收货人名称
receivedTime	收货时间（时间戳格式）
vendorId	供应商id
vendorName	供应商名称
comment	变更单的变更说明
status	订单状态（1：草稿、2:已提交、3:已审批、4:已驳回、5:已完成）
details	收货管理单包含的物品详情集合
attachments	附件信息（请从pc端操作附件）

收货管理单包含的物品详情

属性名称	说明
id	子表id
receivedId	收货管理单id
skuId	物品id（资产或耗材的原id）
skuName	物品名称
skuCode	物品编码
measureUnit	物品计量单位
specs	物品规格型号
skuType	物品类型（1:资产、2:耗材）
assetTypeCode	资产分类编码
assetTemplateName	资产标准名称
displayIndex	显示的行号（物品的序列号）
orderDetailId	关联的采购订单子表id
orderSerialNo	关联的采购订单号
orderQuantity	采购数量
orderAmount	采购金额
price	收货单价
amount	收货金额
taxRate	税率
noTaxAmount	不含税金额
warehouseCode	收货仓库编码
warehouseName	收货仓库名称
districtCode	收货区域编码
districtName	收货区域名称
arrivalQuantity	收货数量
status	物品状态（1:待入库、2:入库中、3:已入库、4:已退货、5:已驳回）