探马OpenAPI

修改合同

POST

/api/v3/contract/edit

编辑合同时，需满足以下条件才可以编辑：
1、合同处于草稿状态
2、审批状态为已解锁且合同不是作废的
3、审批开关没有开启且合同处于提交审批的状态

请求参数

Header 参数

appId

string

应用 appId

必需

默认值:

timestamp

string

请求时间戳

必需

默认值:

sign

string

请求消息签名值

必需

默认值:

appKey

string

应用 appKey

可选

默认值:

Body 参数application/json

contractId

string

探马合同id

必需

title

string

合同标题

可选

传入则修改，不传则不修改，长度不能超出30个字符

amount

number

合同金额

可选

传入则修改，不传则不修改

opportunityIds

array [object {2}]

关联商机

可选

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

number

商机id

可选

type

number

编辑时的类型

可选

1新增，2删除

crmOrderIds

array [object {2}]

关联订单

可选

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

number

订单id

可选

type

number

编辑时的类型

可选

1新增，2删除

fields

array [object {2}]

必需

alias

string

调用方合同字段映射别名

必需

values

array[string]

字段value

必需

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

示例

{
    "contractId":"HT.466724103204864",
    "title":"商务合同",
    "amount":500,
    "opportunityIds":[
        {
            "id":289347932423,
            "type":1
        }
    ],
    "crmOrderIds":[
        {
            "id":923843242423,
            "type":1
        }
    ],  
    "fields":[
        {
            "alias":"合同签约日期",
            "values":[
                "2022-03-20"
                ]
        },
        {
            "alias":"客方签约人",
            "values":[
                "客方签约人"
                ]
        },
         {
            "alias":"我方签约人",
            "values":[
                "我方签约人"
                ]
        },
         {
            "alias":"付款方式",
            "values":[
                "在线支付"
                ]
        }
        ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v3/contract/edit' \
--header 'appId;' \
--header 'timestamp;' \
--header 'sign;' \
--header 'appKey: {{appKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "contractId":"HT.466724103204864",
    "title":"商务合同",
    "amount":500,
    "opportunityIds":[
        {
            "id":289347932423,
            "type":1
        }
    ],
    "crmOrderIds":[
        {
            "id":923843242423,
            "type":1
        }
    ],  
    "fields":[
        {
            "alias":"合同签约日期",
            "values":[
                "2022-03-20"
                ]
        },
        {
            "alias":"客方签约人",
            "values":[
                "客方签约人"
                ]
        },
         {
            "alias":"我方签约人",
            "values":[
                "我方签约人"
                ]
        },
         {
            "alias":"付款方式",
            "values":[
                "在线支付"
                ]
        }
        ]
}'

返回响应

🟢200成功

application/json

Body

code

integer

状态码

必需

message

string

响应描述

必需

示例

{
    "code": 0,
    "message": "success"
}

🟢200失败

修改于 2022-09-29 03:20:47

新建合同

查询销售所有部门