合同模块

2021-07-28 09:19:06
王于听
1567
最后编辑:刘若谷 于 2021-08-09 17:26:39
分享链接

一、获取销售合同列表

请求地址:GET   /api.php/v1/crm/contracts

请求头HEADER:

Content-Type: application/json
Token: my-token
Accept-Language:zh-CN,zh

参数列表:

字段
必填 默认值                  描述                 
mode all

all: 全部

contactedby: 由我联系

unfinished: 未完成

unreceived: 回款中

undeliveried: 交付中

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/contracts/' \
--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/contracts/: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/contracts/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/contracts

请求头HEADER:

Content-Type: application/json
Token: my-token
Accept-Language:zh-CN,zh

请求BODY:

字段 必填 类型 描述
company int

所属企业

customer int 所属客户
order array 订单ID
real

array 订单金额
name

stri ng 合同名称
contractCode

string

合同编号

currency


string 货币类型
amount
float

合同金额

createAddress
int
是否新建地址,是的话传递1
newAddress

string

地址信

createAddress = 1,传递该字段

address

int

地址信息

createAddress != 1 传递该字段

signedBy

stri ng
由谁签署
signedDate

stri ng
签署时间
begin

stri ng
合同开始时间
end

stri ng
合同结束时间
items

stri ng
主要条款
contact

stri ng
联系人
handlers

array
贡献者
uid

string
附件id


请求示例:

curl --location --request POST 'https://biz.demo.zdoo.com/api.php/v1/crm/contracts' \
--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":"","address":"0","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=",
    "crontactID": "1"
}

返回结果(400):

{
    "error": errorMessage
}

四、修改销售合同信息

请求地址:PUT  /api.php/v1/crm/contracts/:id

请求头HEADER:

Content-Type: application/json
Token: my-token
Accept-Language:zh-CN,zh

请求BODY:

字段 必填 类型 描述
company int 所属企业
order array 订单ID
real

array 订单金额
name

string 合同名称
code

string 合同编号

currency


string 货币类型
amount
float 合同金额
address

string
地址
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/contracts/1' \
--header 'Token: my-token' \
--header 'Accept-Language: zh-CN,zh' \
--header 'Content-Type: application/json' \ 
--data-raw  '{"company":"1","name":"合同名称","currency":"rmb","amount":"","address":"0","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
}


发表评论
陆 乘 拾 =
评论通过审核后显示。