采购合同模块
- 2021-07-29 10:16:55
- 曹延义
- 2944
- 最后编辑：刘若谷 于 2021-08-09 17:32:22
- 分享链接
一、获取采购合同列表
请求地址：GET /api.php/v1/crm/purchasecontracts
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
参数列表：
|
字段 |
必填 | 默认值 | 描述 |
| mode | 否 | all |
all: 全部
contactedby: 由我联系
unfinished: 未完成 unreceived: 付款中
finished: 已完成
canceled: 已取消 expired: 已过期 expire: 即将到期
|
| sort |
否 |
id_desc |
按照 "_" 字符前面的字段进行排序 desc为降序 asc 为升序 |
|
total |
否 |
0 |
总数量 |
|
limit |
否 |
20 |
分页数量 |
|
page |
否 |
1 |
页码 |
请求示例：
curl --location --request GET 'https://biz.demo.zdoo.com/api.php/v1/crm/purchasecontracts/' \ --header 'Token: my-token' \ --header 'Accept-Language: zh-CN,zh' \ --header 'Content-Type: application/json'
返回结果(200)：
{
"status": "success",
"data": {Objects}
}
|
字段 |
类型 | 描述 |
|
contracts |
string | 合同列表 |
| pager | object | 分页信息 |
|
currencySign |
object |
货币单位 |
|
currencyList |
object |
货币类型 |
|
type |
string |
合同类型 |
|
moduleType |
string |
模块类型 |
|
totalAmount |
object |
总金额 |
二、获取采购合同详情
请求地址：GET /api.php/v1/crm/purchasecontracts/:id
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
请求示例：
curl --location --request GET 'https://biz.demo.zdoo.com/api.php/v1/crm/purchasecontracts/1' \ --header 'Token: my-token' \ --header 'Accept-Language: zh-CN,zh' \ --header 'Content-Type: application/json'
返回结果(200)：
{
"status": "success",
"data": {Objects}
}
|
字段 |
类型 | 描述 |
|
title |
string | 页面标题 |
| companies | object | 采购合同信息 |
| allCustomers | object | 供应商信息 |
| contacts | object | 联系人信息 |
| products | object | 产品信息 |
| users | object | 相关用户名 |
|
currencySign |
object | 货币符号 |
|
currencyList |
object |
货币类型 |
|
depositorList |
object |
回款记录 |
|
preAndNext |
object | 上一条和下一条采购合同信息 |
|
appOperate |
array | 移动端所属该采购合同的动作 |
三、创建采购合同信息
请求地址：POST /api.php/v1/crm/purchasecontracts
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
请求BODY：
| 字段 | 必填 | 类型 | 描述 |
| company | 否 | int |
所属企业 |
| customer | 是 | int | 供应商 |
|
name |
是 |
string | 合同名称 |
|
contractCode |
否 |
string | 合同编号 |
|
currency |
否 |
string | 货币类型 |
|
amount |
否 | float |
合同金额 |
|
signedBy |
否 |
string |
由谁签署 |
|
signedDate |
否 |
string |
签署时间 |
|
begin |
否 |
string |
合同开始时间 |
|
end |
否 |
string |
合同结束时间 |
|
items |
否 |
string |
主要条款 |
|
contact |
否 |
string |
联系人 |
|
handlers |
否 |
array |
贡献者 |
|
uid |
否 |
string |
附件id |
请求示例：
curl --location --request POST 'https://biz.demo.zdoo.com/api.php/v1/crm/purchasecontracts' \
--header 'Token: my-token' \
--header 'Accept-Language: zh-CN,zh' \
--header 'Content-Type: application/json' \
--data-raw '{"company":"1","customer":"3","name":"合同名称","currency":"rmb","amount":"","signedBy":"admin","signedDate":"","begin":"","end":"","items":"","uid":"admin1627287008703","contact":"0","handlers":["admin"],"code":["","","","","abc",""]}'
返回结果(200)：
{
"result": "success",
"message": "保存成功",
"locate":"/crm/api.php?m=contract&f=browse&t=",
"contractID": "57"
}
返回结果(400)：
{
"error": errorMessage
}
四、修改采购合同信息
请求地址：PUT /api.php/v1/crm/purchasecontracts/:id
请求头HEADER：
Content-Type: application/json Token: my-token Accept-Language:zh-CN,zh
请求BODY：
| 字段 | 必填 | 类型 | 描述 |
| company | 否 | int | 所属企业 |
|
name |
是 |
string | 合同名称 |
|
code |
是 |
string | 合同编号 |
|
currency |
否 |
string | 货币类型 |
|
amount |
否 | float |
合同金额 |
|
signedBy |
否 |
string |
由谁签署 |
|
signedDate |
否 |
string |
签署时间 |
|
begin |
否 |
string |
合同开始时间 |
|
end |
否 |
string |
合同结束时间 |
|
items |
否 |
string |
主要条款 |
|
contact |
否 |
string |
联系人 |
|
handlers |
否 |
array |
贡献者 |
|
uid |
否 |
string |
附件id |
请求示例：
curl --location --request PUT 'https://biz.demo.zdoo.com/api.php/v1/crm/purchasecontracts/1' \
--header 'Token: my-token' \
--header 'Accept-Language: zh-CN,zh' \
--header 'Content-Type: application/json' \
--data-raw '{"company":"1","name":"合同名称","currency":"rmb","amount":"","signedBy":"admin","signedDate":"","begin":"","end":"","items":"","uid":"admin1627287008703","contact":"0","handlers":["admin"]}'
返回结果(200)：
{ "result": "success",
"message": "保存成功",
"locate": "/crm/api.php?m=contract&f=view&t=&contractID=43"
}
返回结果(400): {
"error": errorMessage
}