供应商管理接口

1. 获取供应商列表

请求地址

GET /Purchase/Vendor

参数说明

参数	是否必须	说明
isdeleted	否	是否显示已删除的供应商（1:显示、2:不显示）

供应商查询接口支持丰富的条件过滤参数，请参见支持的查询参数附录

返回结果

{
    "offset": 0,
    "total": 13,
    "results": [
        {
            "id": "4e0024ac-8c9f-4946-bc77-de6a1e4801e0",
            "name": "苏宁易购",
            "contacts": "李广飞",
            "phoneNumber": "021-30866743",
            "bankName": "建设银行",
            "bankAccount": "2321322154210693820",
            "comment": "采购",
            "isDeleted": false
        }
    ],
    "meta": {}
}

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

2. 新增供应商

请求地址

POST /Purchase/Vendor

请求示例

{
    "name": "供应商",
    "contacts": "张三",
    "phoneNumber": "13612314244",
    "bankName": "建设银行",
    "bankAccount": "银行户",
    "comment": "备注"
}

参数说明

参数	是否必须	说明
name	是	供应商名称
contacts	否	联系人
phoneNumber	否	联系电话
bankName	否	付款开户行
bankAccount	否	付款开户账号
comment	否	备注

返回结果

{   
    "id":"3a323ba5-2bf7-4940-af93-d06e026a1005"
}

结果说明

属性名称	说明
id	供应商id

3. 修改供应商

请求地址

POST Purchase/Vendor/put

请求示例

{
    "id": "3a323ba5-2bf7-4940-af93-d06e026a1005",
    "name": "供应商",
    "contacts": "张三",
    "phoneNumber": "13612314244",
    "bankName": "建设银行",
    "bankAccount": "银行户",
    "comment": "备注"
}

参数说明

参数	是否必须	说明
id	是	供应商id
name	是	供应商名称
contacts	否	联系人
phoneNumber	否	联系电话
bankName	否	付款开户行
bankAccount	否	付款开户账号
comment	否	备注

返回结果

{   
    "id":"3a323ba5-2bf7-4940-af93-d06e026a1005"
}

结果说明

属性名称	说明
id	供应商id

4. 删除供应商

请求地址

POST /Purchase/Vendor/delete

请求示例

{
    "id": "3a323ba5-2bf7-4940-af93-d06e026a1005"
}

参数说明

参数	是否必须	说明
id	是	供应商id

返回结果

{}

对于成功删除的请求，该接口仅返回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
name	供应商名称
contacts	联系人
phoneNumber	联系电话
bankName	付款开户行
bankAccount	付款开户账号
comment	备注
isDeleted	是否被删除