探马OpenAPI

新建合同

POST

/api/v3/contract/create

通过该接口新建合同，审批状态均为“未提交”状态

请求参数

Header 参数

appId

string

应用 appId

必需

默认值:

timestamp

string

请求时间戳

必需

默认值:

sign

string

请求消息签名值

必需

默认值:

appKey

string

应用 appKey

可选

默认值:

Body 参数application/json

title

string

合同标题

必需

长度不能超出30个字符

customerId

number

探马客户id

必需

amount

number

合同金额

必需

departmentId

number

部门id

必需

通过 “查询销售所有部门” 接口查询，可查询多个部门，选择其一即可

opportunityIds

array[number]

关联商机id集合

可选

通过 “查询客户商机” 接口查询

crmOrderIds

array[number]

关联订单id集合

可选

通过 “查询客户合同关联订单” 接口查询

salesId

number

负责人id（探马内销售id）

必需

fields

array [object {2}]

自定义字段映射列表

必需

alias

string

调用方合同字段映射别名

必需

values

array[string]

字段value

必需

只有多选字段可以提供多于一个值，其他类型字段只应传一个值；不论是否单、多选字段，需要传值，而不是传值id，平台内部进行转换，如果传入的值不是可选项中的值，非法；

示例

{
  "title": "测试1118",
  "customerId": 456684054755392,
  "amount": 200,
  "departmentId": 3765,
  "salesId": 565323265652655,
  "opportunityIds": [
    289347932423
  ],
  "crmOrderIds": [
    923843242423
  ],
  "fields": [
    {
      "alias": "合同类型",
      "values": [
        "多看看"
      ]
    },
    {
      "alias": "合同开始日期",
      "values": [
        "2021-03-20"
      ]
    },
    {
      "alias": "合同结束日期",
      "values": [
        "2021-03-30"
      ]
    },
    {
      "alias": "多选项",
      "values": [
        "多选项一",
        "多选项二",
        "多选项三"
      ]
    },
    {
      "alias": "合同状态",
      "values": [
        "3"
      ]
    },
    {
      "alias": "合同附件",
      "values": [
        "{'name':'公海个人客户模板 (6).xlsx','fileId':'group3/M00/1B/24/rBHDsmI0heeAAxMkAAAoHXSy-T894.xlsx','size':10269,'url':'https://dev.tanmarket.cn/fdfsServer/group3/M00/1B/24/rBHDsmI0heeAAxMkAAAoHXSy-T894.xlsx','type':'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet','uid':1647609320663,'status':'success'}",
        "{'name':'rBHTwWIM5-6AJOe-AAARnRXiq3A12.xlsx','fileId':'group3/M00/90/41/rBHTdWI0hf6AQdRsAAARnU0vopE54.xlsx','size':4509,'url':'https://dev.tanmarket.cn/fdfsServer/group3/M00/90/41/rBHTdWI0hf6AQdRsAAARnU0vopE54.xlsx','type':'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet','uid':1647609344058,'status':'success'}"
      ]
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v3/contract/create' \
--header 'appId;' \
--header 'timestamp;' \
--header 'sign;' \
--header 'appKey: {{appKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title":"测试1118",
    "customerId":456684054755392,
    "amount":200,
    "departmentId":3765,
    "salesId":565323265652655,
	"opportunityIds":[
        289347932423
    ],
    "crmOrderIds":[
        923843242423
    ],  
    "fields":[
        {
            "alias":"合同类型",
            "values":[
                "多看看"
                ]
        },
        {
            "alias":"合同开始日期",
            "values":[
                "2021-03-20"
                ]
        },
         {
            "alias":"合同结束日期",
            "values":[
                "2021-03-30"
                ]
        },
        {
            "alias":"多选项",
            "values":[
                "多选项一",
                "多选项二",
                "多选项三"
                ]
        },
        {
           "alias":"合同状态",
           "values":[
               "3"
               ]
        },
        {
            "alias":"合同附件",
            "values":[
                "{'\''name'\'':'\''公海个人客户模板 (6).xlsx'\'','\''fileId'\'':'\''group3/M00/1B/24/rBHDsmI0heeAAxMkAAAoHXSy-T894.xlsx'\'','\''size'\'':10269,'\''url'\'':'\''https://dev.tanmarket.cn/fdfsServer/group3/M00/1B/24/rBHDsmI0heeAAxMkAAAoHXSy-T894.xlsx'\'','\''type'\'':'\''application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'\'','\''uid'\'':1647609320663,'\''status'\'':'\''success'\''}",
                "{'\''name'\'':'\''rBHTwWIM5-6AJOe-AAARnRXiq3A12.xlsx'\'','\''fileId'\'':'\''group3/M00/90/41/rBHTdWI0hf6AQdRsAAARnU0vopE54.xlsx'\'','\''size'\'':4509,'\''url'\'':'\''https://dev.tanmarket.cn/fdfsServer/group3/M00/90/41/rBHTdWI0hf6AQdRsAAARnU0vopE54.xlsx'\'','\''type'\'':'\''application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'\'','\''uid'\'':1647609344058,'\''status'\'':'\''success'\''}"
                ]
        }
        ]
}'

返回响应

🟢200成功

application/json

Body

code

integer

状态码

必需

示例：0

message

string

响应描述

必需

示例：success

data

object

响应数据

必需

tanmaContractId

string

探马合同id

必需

示例

{
  "code": 0,
  "message": "success",
  "data": {
    "tanmaContractId": "HT.212391023131",
    "customerId": "EX.3781283192312"
  }
}

🟢200失败

修改于 2023-04-11 12:18:06

合同扩展字段

修改合同