TIP

• 新增客户合同任务接口
• 查询客户合同类型接口
• 查询乙方客户签署合同任务接口
• 第三方签署文件回传
• 获取系统认证过的甲方企业信息
• 查询电子合同数据
• 新增线下合同接口
• 编辑线下合同接口
• 编辑线下合同附件
• 查询线下合同

提示：通过合同接口创建的合同，甲方企业必须通过自有系统进行签署，勤策平台界面仅支持查看，乙方仍可以正常通过订货平台签署

客户合同接口

新增客户合同任务接口

请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/contract/v1/addContract/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "contract_code": "CM0001",
    "contract_name": "CM0001-name",
    "contract_start_date": "2022-06-01",
    "contract_end_date": "2022-08-01",
    "contract_type": "7389771106639629767",
    "part_a_tenant": "7389771106639629767",
    "part_a_auth": "7389771106639629767",
    "part_a_auth_code": "7389771106639629767",
    "part_b_cm": "7389771106639629767",
    "part_b_cm_code": "7389771106639629767",
    "sign_end_date": "2019-09-24",
    "unsign_file_url": "http://XXX/XXX/XXX/XXX/pdf",
    "remark": "XXX",
    "creator_id":"7389771106639629767",
    "pos_list": [
        {
            "signType": "1",
            "part_a_keyword": "123456789",
            "part_b_keyword": "123456789"
        },
        {
            "signType": "2",
            "part_a_position_x": "200",
            "part_a_position_y": "200",
            "part_a_sign_page": "1-2",
            "part_b_position_x": "200",
            "part_b_position_y": "200",
            "part_b_sign_page": "1-2"
        },
        {
            "signType": "3",
            "part_a_seal_y": "200",
            "part_b_seal_y": "400"
        }
    ]
}

说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
contract_code	VARCHAR(32)	是	合同编号
contract_type	VARCHAR(32)	是	合同类型ID
part_a_tenant	VARCHAR(32)	是	甲方签署企业ID
part_a_auth	VARCHAR(32)	是	甲方授权人ID
part_a_auth_code	VARCHAR(32)	是	甲方授权人CODE
part_b_cm	VARCHAR(32)	是	乙方签署客户ID
part_b_cm_code	VARCHAR(32)	是	乙方签署客户CODE
sign_end_date	VARCHAR(32)	是	签署截止日期。格式：yyyy-MM-dd
unsign_file_url	VARCHAR(4000)	是	签署文件URL
contract_name	VARCHAR(32)	否	合同名称，如不传直接取乙方的客户编码
contract_start_date	VARCHAR(32)	否	合同有效起始日期。格式：yyyy-MM-dd
contract_end_date	VARCHAR(32)	否	合同有效结束日期。格式：yyyy-MM-dd
remark	VARCHAR(1000)	否	备注
creator_id	VARCHAR(32)	否	创建人ID
pos_list	List	否	列表
pos_list.signType	VARCHAR(32)	否	签署位置定位方式。1：关键字，2，坐标，3：骑缝章
pos_list.part_a_keyword	VARCHAR(32)	否	甲方关键字。当选择关键字定位时甲乙方关键字最少填一个
pos_list.part_b_keyword	VARCHAR(32)	否	乙方关键字。当选择关键字定位时甲乙方关键字最少填一个
pos_list.part_a_position_x	VARCHAR(32)	否	甲方坐标定位-x坐标。当选择甲方坐标定位,传参时x坐标、y坐标、页码信息均不能为空，x坐标取值范围[153,595]
pos_list.part_a_position_y	VARCHAR(32)	否	甲方坐标定位-y坐标。y坐标取值范围[153,842]
pos_list.part_a_sign_page	VARCHAR(32)	否	甲方坐标定位-页码
pos_list.part_b_position_x	VARCHAR(32)	否	乙方坐标定位-x坐标。当选择乙方坐标定位，传参时x坐标、y坐标、页码信息均不能为空，x坐标取值范围[153,595]
pos_list.part_b_position_y	VARCHAR(32)	否	乙方坐标定位-y坐标 。y坐标取值范围[153,842]
pos_list.part_b_sign_page	VARCHAR(32)	否	乙方坐标定位-页码
pos_list.part_a_seal_y	VARCHAR(32)	否	甲方骑缝章y坐标。当选择骑缝章时，甲乙方骑缝章y坐标均不能为空
pos_list.part_b_seal_y	VARCHAR(32)	否	乙方骑缝章y坐标

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
        {
            "contract_id": "7863150652620035205"
        }
]

参数说明：

参数	类型	说明
contract_id	VARCHAR(32)	合同id(业务流程ID)

查询客户合同类型接口

请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/contract/v1/queryContractType/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{   
}

说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
无

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
        {
            "id": "7863150652620035205",
            "code": "CM0001",
            "name": "默认合同类型",
			"status":"1",
			"is_use":"1",
			"remark":"备注"
        }
]

参数说明：

参数	类型	必填	说明
id	VARCHAR(32)		类型id
name	VARCHAR(100)		类型名称
code	VARCHAR(32)		类型编码
status	VARCHAR(32)		是否删除。1：正常，0：删除
is_use	VARCHAR(32)		是否启用。1：启用
remark	VARCHAR(100)		备注

查询乙方客户签署合同任务接口

请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/contract/v1/queryContractAfterPartB/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "contract_id":"7863150652620035205",
    "contract_code": "CM0001"
}

说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
contract_id	varchar(32)	否	合同id (业务流程ID)，合同id和合同code不能同时为空
contract_code	varchar(32)	否	合同code (合同编码)，合同id和合同code不能同时为空
contract_status	varchar(32)	否	合同状态。1：待签署，2：签署中，3：已签署，4：已拒签，6：已撤销

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
        {
            "id": "7863150652620035205",
			"status":"1",
			"create_time":"2019-10-22",
            "contract_code": "CM0001",
            "contract_type": "合同类型",
			"contract_type_name":"合同类型名称",
			"contract_type_code":"合同类型编码",
            "part_a_tenant":"7863150652620035205",
            "part_a_auth":"7863150652620035205",
            "part_a_auth_code":"dddddd",
            "part_b_cm": "7389771106639629767",
            "part_b_cm_code": "cccccc",
            "sign_end_date": "2019-09-24",
            "file_url": "http://XXX/XXX/XXX/XXX/pdf",
            "remark":"",
			"contract_name":"合同名称",
			"contract_show_name":"合同名称.pdf",
			"contract_status":"1",
            "part_b_sign_time":"2019-10-22 15:30",
			"part_a_sign_time":"2019-10-22 15:30",
			"part_b_auth":"7863150652620035205",
			"reject_reason":"拒绝理由"
            
        }
]

参数说明：

参数	类型	必填	说明
id	VARCHAR(32)	是	合同id(业务流程ID)
status	varchar(32)	是	状态。1：正常，0：删除
create_time	varchar(32)	是	创建时间。格式：yyyy-MM-dd
contract_code	VARCHAR(32)	是	合同编号
contract_type	VARCHAR(32)	是	合同类型ID
contract_type_name	VARCHAR(32)	是	合同类型名称
contract_type_code	VARCHAR(32)	是	合同类型编码
part_a_tenant	VARCHAR(32)	是	甲方签署企业ID
part_a_auth	VARCHAR(32)	是	甲方授权人ID
part_a_auth_code	VARCHAR(32)	是	甲方授权人code
part_b_cm	VARCHAR(32)	是	乙方签署客户ID
part_b_cm_code	VARCHAR(32)	是	乙方签署客户code
sign_end_date	VARCHAR(32)	是	签署截止日期。格式：yyyy-MM-dd
file_url	VARCHAR(4000)	是	签署文件URL
remark	VARCHAR(1000)	否	备注
contract_name	VARCHAR(32)	是	合同名称
contract_status	VARCHAR(32)	是	合同状态
part_b_sign_time	VARCHAR(32)	否	乙方签署时间。格式：yyyy-MM-dd HH:mi
part_a_sign_time	VARCHAR(32)	否	甲方签署时间。格式：yyyy-MM-dd HH:mi
part_b_auth	VARCHAR(32)	否	乙方签署人
reject_reason	VARCHAR(100)	否	拒绝理由
contract_show_name	VARCHAR(100)	是	合同名称,如果在新增合同时有传该字段，则保存对应的所传信息，如果不传，则为文件url中截取的部分，例如http://AAA/BBB/CCC.pdf截取为CCC.pdf

第三方签署文件回传

请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/contract/v1/signByPartA/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "contract_id":"7863150652620035205",
    "sign_file_url":""
}

说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
contract_id	varchar(32)	是	合同id (业务流程ID)
sign_file_url	varchar(4000)	否	甲方签署后文件url

响应示例：

{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}

参数说明：

参数	类型	说明
msg_id	String	请求消息ID
return_code	int	响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg	String	响应说明

获取系统认证过的甲方企业信息

请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/contract/v1/getTenantVerification/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
}

说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
无

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",  
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
    {
        "tenantId":"1",
        "tenantName":"xxx科技公司",
        "artificialPerson":"张三",
        "artificialMobile":"18455124451"
    }
]

参数说明：

字段名	类型	说明
tenantId	VARCHAR(32)	系统认证企业对应的勤策id
tenantName	VARCHAR(32)	系统认证企业名字
artificialPerson	VARCHAR(32)	系统认证法人的名字
artificialMobile	VARCHAR(32)	法人手机号码

查询电子合同数据

请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/contract/v1/getOnlineContracts/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
  "page_number": "1",
  "page_length": "1000",
  "code":"XSHT_202209267939",
  "contract_status":"1",
  "start_create_date":"2022-09-26 14:09:04",
  "end_create_date":"2022-09-26 14:09:05",
  "start_modify_date":"2022-09-26 14:09:04",
  "end_modify_date":"2022-09-26 14:09:05",
  "type_id":"2",
  "type_code":"CUS000034"
}

说明： 本示例仅供参考。

参数说明：

参数	类型	必填	说明
page_number	varchar(32)	否	页码默认1
page_length	varchar(32)	否	每页默认1000条
code	varchar(32)	否	合同编号
contract_status	varchar(32)	否	合同状态。1：待签署，2：签署中，3：已签署，4：已拒签，6：已撤销，7：待填写，8：填写中
start_create_date	varchar(32)	否	开始创建时间。格式：YYYY-MM-DD hh:mm:ss
end_create_date	varchar(32)	否	结束创建时间。格式：YYYY-MM-DD hh:mm:ss
start_modify_date	varchar(32)	否	开始修改时间。格式：YYYY-MM-DD hh:mm:ss
end_modify_date	varchar(32)	否	结束修改时间。格式：YYYY-MM-DD hh:mm:ss
type_id	varchar(32)	否	签署人的类型： 1-企业 2-客户 0-员工
type_code	varchar(32)	否	签署人编码：若是客户则需要传客户编码,若是企业或员工则需要传入员工编码

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",  
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
  {
    "contract_amount":"",
    "modify_name":"cjj",
    "contract_status":"1",
    "modify_time":"2022-09-26 14:09:04",
    "is_remind":"0",
    "remark":"",
    "contract_start_date":"2022-09-05",
    "contract_end_date":"2022-10-09",
    "contract_code":"XSHT_202209267939",
    "sign_end_date":"2022-10-08",
    "refuse_code":"",
    "contract_type_name":"企业章",
    "pay_type_id":"",
    "responsible_person_code":"021601",
    "remind_days":"",
    "id":7657350526962485177,
    "create_code":"cjj",
    "sales_opportunity_id":"",
    "current_signer_code":"yp",
    "create_time":"2022-09-26 14:09:04",
    "refuse_name":"",
    "refuse_reason":"",
    "contract_name":"cjj-企业-员工-客户",
    "sign_party":[
      {
        "signer_name":"yp",
        "org_type":"1",
        "signer_code":"yp"
      },
      {
        "signer_name":"cjj",
        "org_type":"0",
        "signer_code":"cjj"
      },
      {
        "signer_name":"062301",
        "org_type":"2",
        "signer_code":"CUS000034"
      }
    ],
    "auto_stamp":"1",
    "refuse_time":"",
    "sign_file_url":"https://wqcloud.shcengyu.com/contract_redirect/6264681423410307926/customer_contract_contract/202209/origin/7797954029192820435.pdf?Expires=1665838227&OSSAccessKeyId=LTAI4Fkk66e1yEYkeG8dykyp&Signature=u3Y0jmJWahHl6883bD3yTxUYaw8%3D",
    "responsible_person_name":"021601",
    "sales_opportunity_name":"",
    "pay_type_name":"",
    "modify_code":"cjj",
    "current_signer_name":"yp",
    "create_name":"cjj"
  }
]

参数说明：

字段名	类型	说明
contract_code	VARCHAR(100)	合同编号
sign_file_url	VARCHAR(1000)	合同文件
contract_name	VARCHAR(100)	合同名称
responsible_person_code	VARCHAR(100)	负责人编码
responsible_person_name	VARCHAR(100)	负责人名称
contract_type_name	VARCHAR(100)	合同类型
sign_party	List	签署方
sign_party.signer_name	VARCHAR(100)	签署方名称
sign_party.org_type	VARCHAR(100)	签署方类型 1-企业 2-客户 0-员工
sign_party.signer_code	VARCHAR(100)	签署方编码
auto_stamp	VARCHAR(100)	是否自动加盖骑缝章 1是2否
sign_end_date	VARCHAR(100)	合同签署截止日期
current_signer_code	VARCHAR(100)	当前处理人编码
current_signer_name	VARCHAR(100)	当前处理人名称
sales_opportunity_id	VARCHAR(100)	所属商机编码
sales_opportunity_name	VARCHAR(100)	所属商机名称
contract_start_date	VARCHAR(100)	合同有效期开始
contract_end_date	VARCHAR(100)	合同有效期结束
contract_status	VARCHAR(100)	签署状态 1：待签署，2：签署中，3：已签署，4：已拒签，6：已撤销，7：待填写，8：填写中
is_remind	VARCHAR(100)	是否到期提醒 1是0否
remind_days	VARCHAR(100)	提前提醒天数
contract_amount	VARCHAR(100)	合同金额
pay_type_name	VARCHAR(100)	付款方式
remark	VARCHAR(1000)	备注
refuse_code	VARCHAR(100)	拒签人编码
refuse_name	VARCHAR(100)	拒签人名称
refuse_time	VARCHAR(100)	拒签时间
refuse_reason	VARCHAR(100)	拒签原因
modify_code	VARCHAR(100)	最后修改人编码
modify_name	VARCHAR(100)	最后修改人名称
modify_time	VARCHAR(100)	最后修改时间
create_code	VARCHAR(100)	创建人编码
create_name	VARCHAR(100)	创建人名称
create_time	VARCHAR(100)	创建时间

新增线下合同接口

请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/contract/v1/addOfflineContract/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
  "customerCode": "CUS000086",
  "customerName": "销售线索测试",
  "creatorCodeOrName": "",
  "createTime": "2023-10-01 00:00:00",
  "modifierCodeOrName": "",
  "modifyTime": "",
  "salesOppoName":"销售线索商机",
  "salesOppoCode":"O2023021400000002",
  "salesOppoGoodCode":"Q2023022200000001",
  "salesOppoGoodName":"报价单测试",
  "contractContent":"",
  "remark":"remark",
  "signerB":"signerB",
  "signerA":"signerA",
  "signBDate": "2023-01-01",
  "signADate": "2023-10-01",
  "payType":"01",
  "isRemind":"1",
  "remindDays":11,
  "contractStartDate":"2023-01-01",
  "contractEndDate":"2023-01-02",
  "contractAmount":22.35,
  "contractName":"contractName",
  "responsiblePersonNameOrCode":"cjj",
  "contractStatus":"01",
  "contractType":"业务合作协议",
  "businessType":"1",
  "contractCode":"",
  "contractFile":"https://image-test.waiqin365.com/7619626022706826512/customer_contract_pdf/XXX.docx",
  "extFields":{"ext_2311040089":"111","ext_2311040088":"222"},
  "products":[
    {
      "productCode":"1000001",
      "productName":"雪花啤酒勇闯天涯8度",
      "discount":"",
      "price":"",
      "amount":"",
      "productExtFields":{"ext_2311040090":"333","ext_2311040091":"444"}
    },
    {
      "productCode":"1000001",
      "productName":"雪花啤酒勇闯天涯8度",
      "discount":"",
      "price":"",
      "amount":"",
      "productExtFields":{"ext_2311040090":"555","ext_2311040091":"666"}
    }
  ]
}

说明： 本示例仅供参考。

参数说明：

参数	类型	必填	说明
customerCode	varchar(32)	是	客户编码(客户名称、客户编码2个必须传一个)
customerName	varchar(32)	是	客户名称(客户名称、客户编码2个必须传一个)
creatorCodeOrName	varchar(32)	否	创建人账号或者名称
createTime	varchar(32)	否	创建时间,格式：yyyy-MM-dd HH:mi:ss
modifierCodeOrName	varchar(32)	否	修改人账号或者名称
modifyTime	varchar(32)	否	修改时间,格式：yyyy-MM-dd HH:mi:ss
salesOppoName	varchar(32)	否	所属商机名称(商机名称和编码可任传一个)
salesOppoCode	varchar(32)	否	所属商机编码(商机名称和编码可任传一个)
salesOppoGoodCode	varchar(32)	否	报价单编号(报价单名称和编码可任传一个)
salesOppoGoodName	varchar(32)	否	报价单名称(报价单名称和编码可任传一个)
contractContent	varchar(32)	否	合同文本
remark	varchar(32)	否	备注
signerB	varchar(32)	否	客户签约人
signerA	varchar(32)	否	我方签约人
signBDate	varchar(32)	否	客户签署日期,格式：yyyy-mm-dd
signADate	varchar(32)	否	我方签署日期,格式：yyyy-mm-dd
payType	varchar(32)	否	付款方式(01:支票,02:现金,03:电汇,04:网上转账,05:支付宝,06:微信支付,07:刷卡,08:其他,)
isRemind	varchar(32)	否	是否开启到期提醒(1:是,0:否)
remindDays	varchar(32)	否	合同到期前多少天提醒,支持整数(开启到期提醒时必传)
contractStartDate	varchar(32)	否	合同有效期起始日期，格式：yyyy-mm-dd
contractEndDate	varchar(32)	否	合同有效期结束日期，格式：yyyy-mm-dd
contractAmount	NUMERIC	否	合同金额
contractName	varchar(32)	是	合同名称
responsiblePersonNameOrCode	varchar(32)	是	合同负责人,可传入员工姓名或员工账号
contractStatus	varchar(32)	否	合同状态(01:待生效,02:生效中,03:已结束,04:意外结束)
contractType	varchar(32)	否	合同类型
businessType	varchar(32)	否	业务用途(1:一般,2：定价,3:定量,4:限定总额)
contractCode	varchar(32)	否	合同编号
contractFile	varchar(32)	否	合同文件,完整的url,限制1个
extFields	object	否	合同自定义字段
extFields.ext_*	varchar(32)	否	合同自定义字段-具体字段值
products	list	否	合同商品（业务用途为定量、定额、限定总额合同不支持传入合同商品）
products.productCode	varchar(32)	否	商品编码(商品名称和商品编码任传一个)
products.productName	varchar(32)	否	商品名称(商品名称和商品编码任传一个)
products.discount	varchar(32)	否	折扣(传入百分数,例:传入100表示不打折,传入80表示打8折)
products.price	varchar(32)	否	每单位商品实际合同售价
products.amount	varchar(32)	否	合同内商品数量。若传商品相关参数,数量不传默认为0
products.productExtFields	object	否	合同商品明细的自定义字段
products.productExtFields.ext_*	varchar(32)	否	合同商品明细的自定义字段-具体字段值

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",  
    "response_data": "<<DATA>>"
}

数据DATA示例:

{
  "return_code": "0",
  "return_msg": null,
  "msg_id": "90b4b267dd3d49aeace879038b1e7291",
  "response_data": "{\"contractId\":\"7983935423184906063\"}"
}

参数说明：

字段名	类型	说明
contractId	VARCHAR(100)	合同id

编辑线下合同接口

请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/contract/v1/updateOfflineContract/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
  "customerCode": "CUS000086",
  "creatorCodeOrName": "",
  "createTime": "2023-10-01 00:00:00",
  "modifierCodeOrName": "",
  "modifyTime": "",
  "customerName": "销售线索测试",
  "salesOppoName":"销售线索商机",
  "salesOppoCode":"O2023021400000002",
  "salesOppoGoodCode":"Q2023022200000001",
  "salesOppoGoodName":"报价单测试",
  "contractContent":"",
  "remark":"remark",
  "signerB":"signerB",
  "signerA":"signerA",
  "signBDate": "2023-01-01",
  "signADate": "2023-10-01",
  "payType":"01",
  "isRemind":"1",
  "remindDays":11,
  "contractStartDate":"2023-01-01",
  "contractEndDate":"2023-01-02",
  "contractAmount":22.35,
  "contractName":"contractName",
  "responsiblePersonNameOrCode":"cjj",
  "contractStatus":"01",
  "contractType":"业务合作协议",
  "contractCode":"",
  "extFields":{"ext_2311040089":"111","ext_2311040088":"222"},
  "products":[
    {
      "productCode":"1000001",
      "productName":"雪花啤酒勇闯天涯8度",
      "discount":"",
      "price":"",
      "amount":"", 
      "productExtFields":{"ext_2311040090":"333","ext_2311040091":"444"}
    },
    {
      "productCode":"1000001",
      "productName":"雪花啤酒勇闯天涯8度",
      "discount":"",
      "price":"",
      "amount":"",
      "productExtFields":{"ext_2311040090":"555","ext_2311040091":"666"}
    }
  ]
}

说明： 本示例仅供参考。

参数说明：

参数	类型	必填	说明
contractCode	varchar(32)	是	合同编号
creatorCodeOrName	varchar(32)	否	创建人账号或者名称
createTime	varchar(32)	否	创建时间,格式：yyyy-MM-dd HH:mi:ss
modifierCodeOrName	varchar(32)	否	修改人账号或者名称
modifyTime	varchar(32)	否	修改时间,格式：yyyy-MM-dd HH:mi:ss
customerCode	varchar(32)	是	客户编码(客户名称、客户编码2个必须传一个)
customerName	varchar(32)	是	客户名称(客户名称、客户编码2个必须传一个)
salesOppoName	varchar(32)	否	所属商机名称(商机名称和编码可任传一个)
salesOppoCode	varchar(32)	否	所属商机编码(商机名称和编码可任传一个)
salesOppoGoodCode	varchar(32)	否	报价单编号(报价单名称和编码可任传一个)
salesOppoGoodName	varchar(32)	否	报价单名称(报价单名称和编码可任传一个)
contractContent	varchar(32)	否	合同文本
remark	varchar(32)	否	备注
signerB	varchar(32)	否	客户签约人
signerA	varchar(32)	否	我方签约人
signBDate	varchar(32)	否	客户签署日期,格式：yyyy-mm-dd
signADate	varchar(32)	否	我方签署日期,格式：yyyy-mm-dd
payType	varchar(32)	否	付款方式(01:支票,02:现金,03:电汇,04:网上转账,05:支付宝,06:微信支付,07:刷卡,08:其他,)
isRemind	varchar(32)	否	是否开启到期提醒(1:是,0:否)
remindDays	varchar(32)	否	合同到期前多少天提醒,支持整数(开启到期提醒时必传)
contractStartDate	varchar(32)	否	合同有效期起始日期，格式：yyyy-mm-dd
contractEndDate	varchar(32)	否	合同有效期结束日期，格式：yyyy-mm-dd
contractAmount	NUMERIC	否	合同金额
contractName	varchar(32)	是	合同名称
responsiblePersonNameOrCode	varchar(32)	否	合同负责人,可传入员工姓名或员工账号
contractStatus	varchar(32)	否	合同状态(01:待生效,02:生效中,03:已结束,04:意外结束)
contractType	varchar(32)	否	合同类型
extFields	object	否	合同自定义字段
extFields.ext_*	varchar(32)	否	合同自定义字段-具体字段值
products	list	否	合同商品
products.productCode	varchar(32)	否	商品编码(商品名称和商品编码任传一个)
products.productName	varchar(32)	否	商品名称(商品名称和商品编码任传一个)
products.discount	varchar(32)	否	折扣(传入百分数,例:传入100表示不打折,传入80表示打8折)
products.price	varchar(32)	否	每单位商品实际合同售价
products.amount	varchar(32)	否	合同内商品数量。若传商品相关参数,数量不传默认为0
products.productExtFields	object	否	合同商品明细的自定义字段
products.productExtFields.ext_*	varchar(32)	否	合同商品明细的自定义字段-具体字段值

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",  
    "response_data": "<<DATA>>"
}

数据DATA示例:

{
  "return_code": "0",
  "return_msg": null,
  "msg_id": "90b4b267dd3d49aeace879038b1e7293",
  "response_data": "{\"contractId\":\"7983935423184906064\"}"
}

参数说明：

字段名	类型	说明
contractId	VARCHAR(100)	合同id

编辑线下合同附件

请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/contract/v1/modifyOfflineContractFile/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
  "contractCode":"C_2023122600000004",
  "modifierCodeOrName":"",
  "modifyTime":"",
  "fileUrl":"https://res.waiqin365.com/d/official/wq/home/video/1.jpg"
}

说明： 本示例仅供参考。

参数说明：

参数	类型	必填	说明
contractCode	varchar(32)	是	合同编号
modifierCodeOrName	varchar(32)	否	修改人账号或者名称
modifyTime	varchar(32)	否	修改时间,格式：yyyy-MM-dd HH:mi:ss
fileUrl	varchar(200)	是	合同附件url

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",  
    "response_data": "<<DATA>>"
}

数据DATA示例:

{
  "return_code": "0",
  "return_msg": null,
  "msg_id": "90b4b267dd3d49aeace879038b1e7292",
  "response_data": "{\"contractId\":\"7983935423184906065\"}"
}

参数说明：

字段名	类型	说明
contractId	VARCHAR(100)	合同id

查询线下合同

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/contract/v1/queryOfflineContract/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
  "page":"1",
  "rows":"100",
  "contractCode":"C_2025040300000018",
  "createStartDate": "2025-04-11 15:48:02",
  "createEndDate": "2025-04-11 15:48:02",
  "modifyStartDate": "2025-04-11 15:48:02",
  "modifyEndDate": "2025-04-11 15:48:02",
  "contractName": "111",
  "responsiblePerson": "111",
  "contractStatus": "1",
  "contractType": "1",
  "customerCode": "CUS001"
}

说明： 本示例仅供参考。

参数说明：

参数	类型	必填	说明
page	varchar(32)	否	页码
rows	varchar(32)	否	页数
contractCode	varchar(32)	否	合同编号
createStartDate	varchar(32)	否	创建开始时间
createEndDate	varchar(32)	否	创建结束时间
modifyStartDate	varchar(32)	否	修改开始时间
modifyEndDate	varchar(32)	否	修改结束时间
contractName	varchar(32)	否	合同名称
responsiblePerson	varchar(32)	否	合同负责人
contractStatus	varchar(32)	否	合同状态，01:待生效、02:生效中 、03：已结束 、04:意外结束
contractType	varchar(32)	否	合同类型
customerCode	varchar(32)	否	客户编码

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",  
    "response_data": "<<DATA>>"
}

数据DATA示例:

[{
  "contract_amount": "",
  "contract_status": "",
  "modify_time": "2025-04-03 17:52:07",
  "is_remind": "否",
  "remark": "",
  "sign_a_date": "",
  "contract_start_date": "2025-04-03",
  "contract_end_date": "2025-04-03",
  "contract_code": "C_2025040300000018",
  "business_type": "",
  "sign_b_date": "",
  "pay_type": "",
  "signer_a": "",
  "remind_days": "",
  "id": "5648135794852953426",
  "signer_b": "",
  "customer_code": "8faga",
  "exts": {
    "field_25tgZ__c": [{
      "code": "1",
      "content": "",
      "label": "选项1",
      "status": "1"
    }],
    "field_BVZZo__c": ""
  },
  "create_time": "2025-04-03 17:52:07",
  "contract_content": "",
  "sale_oppo_good_code": "",
  "contract_name": "11",
  "responsible_person_name": "胡俊",
  "sales_opportunity_name": "",
  "contract_type": "供货合同",
  "creator_name": "",
  "customer_name": "8faga",
  "detail": [{
    "amount": "",
    "price": "",
    "discount": "",
    "product_code": "TEST41160",
    "unit_price": "",
    "product_name": "金丝皇菊（5袋）",
    "exts": {
      "field_PH7me__c": "",
      "field_ohlCz__c": ""
    }
  }],
  "modifyier_name": ""
}]

参数说明：

字段名	类型	说明
contract_code	VARCHAR(100)	合同编号
creator_name	VARCHAR(1000)	创建人
create_time	VARCHAR(100)	创建时间
modifyier_name	VARCHAR(1000)	修改人
modify_time	VARCHAR(100)	修改时间
customer_code	VARCHAR(100)	客户编码
customer_name	VARCHAR(100)	客户名称
sales_opportunity_name	VARCHAR(100)	所属商机名称
sales_opportunity_code	VARCHAR(100)	所属商机编码
sale_oppo_good_code	VARCHAR(100)	报价单编号
sale_oppo_good_name	VARCHAR(100)	报价单名称
contract_content	VARCHAR(100)	合同文本
remark	VARCHAR(1000)	备注
signer_b	VARCHAR(1000)	客户签约人
signer_a	VARCHAR(1000)	我方签约人
sign_b_date	VARCHAR(1000)	客户签署日期
sign_a_date	VARCHAR(1000)	我方签署日期
pay_type	VARCHAR(100)	付款方式
is_remind	VARCHAR(100)	是否到期提醒
remind_days	VARCHAR(100)	提前提醒天数
contract_start_date	VARCHAR(100)	合同有效期开始
contract_end_date	VARCHAR(100)	合同有效期结束
contract_amount	VARCHAR(100)	合同金额
contract_name	VARCHAR(100)	合同名称
responsible_person_name	VARCHAR(100)	合同负责人
contract_status	VARCHAR(100)	合同状态，1:待生效、2:生效中 、3：已结束 、4:意外结束
contract_type	VARCHAR(100)	合同类型
business_type	VARCHAR(100)	业务用途(1:一般,2：定价,3:定量,4:限定总额)
exts	List	自定义字段
detail	List	合同明细
detail.product_code	VARCHAR(100)	商品编码
detail.product_name	VARCHAR(100)	商品名称
detail.unit_price	VARCHAR(100)	单价
detail.discount	VARCHAR(100)	折扣
detail.price	VARCHAR(100)	售价
detail. amount	VARCHAR(100)	数量
detail. exts	VARCHAR(100)	合同明细的自定义字段