API开放平台

TIP

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

# 客户合同接口v2

# 新增线下合同接口

请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/contract/v2/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":{
    "field_kig9p__cywdzm9": "10000.00",
    "field_dacfk__cxuv3jd": "1214123412341234",
    "field_puezh__cdc07gx": "12341234125463457634567",
    "field_db3nn__ctvj575": "2024-07-26",
    "field_xvw5t__cz8n029": "j8gKhgpu",
    "field_swe5j__cpzhpuj": "xA62mwYV,QlmleNPY",
    "field_hlwzg__ccnf37g": [
      {
        "path": "202407/20240726105836448.jpg",
        "name": "",
        "url": "http://image-test.waiqin365.com/6928113655533238100/202407/20240726105836448.jpg"
      },
      {
        "path": "202407/20240726105839142.jpg",
        "name": "",
        "url": "http://image-test.waiqin365.com/6928113655533238100/20240726105839142.jpg"
      }
    ],
    "field_xwbzr__cme9olm": [
      {
        "path": "202407261051786.zip",
        "fileSize": 19808,
        "name": "slidingscreen.zip",
        "url": "http://image-test.waiqin365.com/6928113655533238100/202407261051786.zip"
      },
      {
        "path": "202407261051258.jpg",
        "fileSize": 701562,
        "name": "R-C.jpg",
        "url": "http://image-test.waiqin365.com/6928113655533238100/202407261051258.jpg"
      }
    ]
  },
  "products":[
    {
      "productCode":"1000001",
      "productName":"雪花啤酒勇闯天涯8度",
      "discount":"",
      "price":"",
      "amount":"",
      "productExtFields":{
        "field_kig9p__cywdzm9": "10000.00",
        "field_dacfk__cxuv3jd": "1214123412341234",
        "field_puezh__cdc07gx": "12341234125463457634567",
        "field_db3nn__ctvj575": "2024-07-26",
        "field_xvw5t__cz8n029": "j8gKhgpu",
        "field_swe5j__cpzhpuj": "xA62mwYV,QlmleNPY",
        "field_hlwzg__ccnf37g": [
          {
            "path": "202407/20240726105836448.jpg",
            "name": "",
            "url": "http://image-test.waiqin365.com/6928113655533238100/202407/20240726105836448.jpg"
          },
          {
            "path": "202407/20240726105839142.jpg",
            "name": "",
            "url": "http://image-test.waiqin365.com/6928113655533238100/202407/20240726105839142.jpg"
          }
        ],
        "field_xwbzr__cme9olm": [
          {
            "path": "202407261051786.zip",
            "fileSize": 19808,
            "name": "slidingscreen.zip",
            "url": "http://image-test.waiqin365.com/6928113655533238100/202407261051786.zip"
          },
          {
            "path": "202407261051258.jpg",
            "fileSize": 701562,
            "name": "R-C.jpg",
            "url": "http://image-test.waiqin365.com/6928113655533238100/202407261051258.jpg"
          }
        ]
      }
    }
  ]
}
说明： 本示例仅供参考。

参数说明：

参数 类型 必填 说明
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 否 合同自定义字段，扩展字段集合。json数据格式为{"ext_keyA": "ext_valueA"}。参数格式参考 (opens new window)
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 否 合同商品明细的自定义字段，扩展字段集合。json数据格式为{"ext_keyA": "ext_valueA"}。参数格式参考 (opens new window)

响应示例：

{
    "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/v2/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":{
    "field_kig9p__cywdzm9": "10000.00",
    "field_dacfk__cxuv3jd": "1214123412341234",
    "field_puezh__cdc07gx": "12341234125463457634567",
    "field_db3nn__ctvj575": "2024-07-26",
    "field_xvw5t__cz8n029": "j8gKhgpu",
    "field_swe5j__cpzhpuj": "xA62mwYV,QlmleNPY",
    "field_hlwzg__ccnf37g": [
      {
        "path": "202407/20240726105836448.jpg",
        "name": "",
        "url": "http://image-test.waiqin365.com/6928113655533238100/202407/20240726105836448.jpg"
      },
      {
        "path": "202407/20240726105839142.jpg",
        "name": "",
        "url": "http://image-test.waiqin365.com/6928113655533238100/202407/20240726105839142.jpg"
      }
    ],
    "field_xwbzr__cme9olm": [
      {
        "path": "202407261051786.zip",
        "fileSize": 19808,
        "name": "slidingscreen.zip",
        "url": "http://image-test.waiqin365.com/6928113655533238100/202407261051786.zip"
      },
      {
        "path": "202407261051258.jpg",
        "fileSize": 701562,
        "name": "R-C.jpg",
        "url": "http://image-test.waiqin365.com/6928113655533238100/202407261051258.jpg"
      }
    ]
  },
  "products":[
    {
      "productCode":"1000001",
      "productName":"雪花啤酒勇闯天涯8度",
      "discount":"",
      "price":"",
      "amount":"", 
      "productExtFields":{
        "field_kig9p__cywdzm9": "10000.00",
        "field_dacfk__cxuv3jd": "1214123412341234",
        "field_puezh__cdc07gx": "12341234125463457634567",
        "field_db3nn__ctvj575": "2024-07-26",
        "field_xvw5t__cz8n029": "j8gKhgpu",
        "field_swe5j__cpzhpuj": "xA62mwYV,QlmleNPY",
        "field_hlwzg__ccnf37g": [
          {
            "path": "202407/20240726105836448.jpg",
            "name": "",
            "url": "http://image-test.waiqin365.com/6928113655533238100/202407/20240726105836448.jpg"
          },
          {
            "path": "202407/20240726105839142.jpg",
            "name": "",
            "url": "http://image-test.waiqin365.com/6928113655533238100/202407/20240726105839142.jpg"
          }
        ],
        "field_xwbzr__cme9olm": [
          {
            "path": "202407261051786.zip",
            "fileSize": 19808,
            "name": "slidingscreen.zip",
            "url": "http://image-test.waiqin365.com/6928113655533238100/202407261051786.zip"
          },
          {
            "path": "202407261051258.jpg",
            "fileSize": 701562,
            "name": "R-C.jpg",
            "url": "http://image-test.waiqin365.com/6928113655533238100/202407261051258.jpg"
          }
        ]
      }
    }
  ]
}
说明： 本示例仅供参考。

参数说明：

参数 类型 必填 说明
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 否 合同自定义字段，扩展字段集合。json数据格式为{"ext_keyA": "ext_valueA"}。参数格式参考 (opens new window)
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 否 合同商品明细的自定义字段，扩展字段集合。json数据格式为{"ext_keyA": "ext_valueA"}。参数格式参考 (opens new window)

响应示例：

{
    "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

← 客户联系人接口 →