发起合同解约

更新时间:2024-09-11 11:22:43

接口描述

原流程中的合同文件在签署方均已完成签署的前提下,其中的任一签署方或原流程的发起方可以申请发起合同解约。通过此接口发起合同解约后,再通过解约签署流程ID去调用【获取签署页面链接】接口获取解约协议的签署链接(或者通过系统自带的短信/邮箱自动发送信息通知)。签署方收到解约协议签署链接后,重新签订一份 “解约协议”,“解约协议”签署成功后,原签署文件将失效。

注意事项:

  • 仅限已完成状态流程中的签署方或发起方来发起合同解约;
  • 单方签署的流程不支持发起解约(流程中必须包含2个及以上的签署方)。

接口地址&请求方法

接口地址:https://{host}/v3/sign-flow/{signFlowId}/initiate-rescission

请求方法:POST

请求头格式

具体请求头参数,请查看公共请求头格式。

请求参数

展开全部参数参数名称

参数类型

必选

参数位置

参数说明(请左右滑动查看完整描述)

signFlowId

string

是

path

已完成状态的签署流程ID

rescindFileList

list

是

body

本次需要解约的签署文件ID列表(一次解约最多可添加10份文件)

【注】文件ID必须是原签署流程中的文件

rescindReason

string

是

body

解约原因(传对应的数字枚举值)

1 - 条款内容有误

2 - 印章选择错误

3 - 签署人信息错误

4 - 合作终止

5 - 其他

rescindReasonNotes

string

否

body

解约原因说明,最长200字

rescissionInitiator

object

是

body

合同解约发起方信息

  • 仅原流程中的签署方或发起方可以发起解约;
  • 发起方需先经过 用户授权(代个人/企业用户发起合同签署权限);
  • psnInitiator与orgInitiator二选一传入。

psnInitiator

object

否

body

解约发起人信息

psnId

string

否

body

个人账号ID

orgInitiator

object

否

body

解约发起机构信息

orgId

string

否

body

机构账号ID

transactor

object

否

body

机构经办人信息

psnId

string

否

body

经办人账号ID

signFlowConfig

object

否

body

解约流程配置项

chargeConfig

object

否

body

解约流程的计费配置项

chargeMode

int32

否

body

计费模式,默认0,(若传1,需获取发起方的套餐订单使用授权,且发起方必须是机构)

0 - 接口集成方付费(指应用ID所属企业)

1 - 解约发起方企业付费(发起方见上文rescissionInitiator参数)

orderType

string

否

body

订单套餐类型,默认为普通订单套餐

可选值:DISTRIBUTION - 生态伙伴订单套餐

【注】只有已登记成为系统生态伙伴之后,才允许传值DISTRIBUTION

signConfig

object

否

body

签署配置项

availableSignClientTypes

string

否

body

签署终端类型,默认值1和2(英文逗号分隔)

1 - 网页(自适配H5/PC样式),2 - 支付宝

psnSealStyles

string

否

body

页面可选个人印章样式,默认值0和1(英文逗号分隔)

0 - 手写签名

1 - 姓名印章

2 - 手写签名AI校验

noticeConfig

object

否

body

解约协议通知配置项(通知原流程中的签署方、抄送方)

noticeTypes

string

否

body

通知类型,默认值为""空字符串

"" - 不进行任何通知

1 - 短信通知

examineNotice

boolean

否

body

通知给企业印章用印审批人员的通知类型,按照账号中的手机号的填写情况进行通知。

不传 - 取noticeTypes的配置
true - 发送通知
false - 不发送通知

notifyUrl

string

否

body

接收合同解约回调通知的Web地址

详见【签署回调通知接收说明】

autoSignOrg

array

否

body

指定本次解约使用自动签署的机构签署方

补充说明:

  • 只有appId所属的平台方企业或者授权平台方印章的企业才能自动签署
  • 跨企业印章授权的解约自动签,必须传入印章归属方的授权方(委托方)企业信息
  • 同一个企业,必须选择平台自动签和经办人手动签中的一种,且不能同时选择(autoSignOrg和orgSignerTransactor)

orgId

string

否

body

机构签署方账号ID(orgName与orgId二选一传值即可)

orgName

string

否

body

机构签署方名称(orgName与orgId二选一传值即可)

sealId

string

否

body

若自动签,该参数必传,且必须传入解约参与方的印章ID(必须是企业印章ID,不能使用法人章)

orgSignerTransactor

array

否

body

指定本次解约机构签署方经办人信息

补充说明:

  • 可以在这里指定更换原有签署机构的经办人;
  • 若原有流程是机构自动签署的话是没有经办人信息的,可以通过autoSignOrg指定自动签署。

orgId

string

否

body

机构签署方账号ID(orgName与orgId二选一传值即可)

orgName

string

否

body

机构签署方名称(orgName与orgId二选一传值即可)

transactorInfo

object

否

body

机构经办人信息

psnId

string

否

body

经办人ID(指定orgId时,传该参数)

psnAccount

string

否

body

经办人账号(指定orgName时,传该参数)

psnName

string

否

body

经办人姓名

响应参数

展开全部参数参数名称

参数类型

必选

参数说明

code

int32

是

业务码,0表示成功,非0表示异常。

message

string

否

业务信息

请根据 code 来判断错误情况,不应该依赖 message匹配,因为 message 可能会调整。

data

object

否

业务数据

signFlowId

string

否

解约协议签署流程ID

请求示例

构造请求JSON时,请结合上方【请求参数】中参数名称、参数类型、必选和参数位置的描述进行设置。

{
    "rescindReason": "1",
    "rescindFileList": [
        "f78dd1****33f0d122b74"
    ],
    "rescissionInitiator": {
        "orgInitiator": {
            "orgId": "842ec8ce3*****5fc91662f",
            "transactor": {
                "psnId": "7ffcae******0ef0a8f6"
            }
        }
    },
    "signFlowConfig": {
        "notifyUrl": "http://*******/notify"
    },
    "orgSignerTransactor": [
        {
            "orgName": "********有限公司",
            "transactorInfo": {
                "psnAccount": "153****0000"
            }
        }
    ]
}

响应示例

解析响应JSON时,请结合上方【响应参数】中描述进行处理。同时需要考虑进行JSON反序列化容错处理。

{
    "code": 0,
    "message": "成功",
    "data": {
        "signFlowId": "0f0c2112f******4ed3aea"
    }
}

错误码

点击查看错误码