甄零开放平台
  1. 3.合同管理
甄零开放平台
  • 开发者指南
    • 开发者指南(必读)
    • 集成示例(必读)
    • 错误码
    • 数据字典
    • 更新日志
  • 1.认证及授权
    • 1.1 获取 Token
      POST
  • 2.主数据管理
    • 2.1 相对方批量查询
      POST
    • 2.2 相对方创建及更新
      POST
    • 4.1 组织信息创建及更新
      POST
    • 4.2 岗位创建及更新
      POST
    • 4.3 员工创建及更新
      POST
    • 4.4 值集创建及更新
      POST
    • 4.5 独立值集值查询
      POST
    • 5.3 物料创建及更新
      POST
  • 3.合同管理
    • 查询合同关联数据
      • 3.27 查询合同相对方
      • 3.28 查询合同关联资源
      • 3.29 查询合同关联关系
      • 3.30 查询合同租赁条款
      • 3.31 查询合同扩展信息
      • 3.32 查询合同自定义合同行
      • 3.33 查询合同行
      • 3.34 查询合同付款计划
      • 3.35 查询合同收款计划
      • 3.36 查询合同审批记录
      • 3.37 查询合同归档信息
      • 3.38 查询合同归附件
      • 3.39 查询合同授权信息
      • 3.40 查询合同正文
      • 3.41 查询合同签约信息
    • 变更
      • 3.45 合同老变更删除
      • 3.46 合同新变更删除
      • 3.47 旧变更提交校验接口
      • 3.48 是否可发起新变更校验接口
      • 3.19 查询合同是否存在在途的变更
    • 3.4 合同文件上传
      POST
    • 3.5 获取文件预览链接
      POST
    • 3.6 模板变量查询
      POST
    • 3.7 合同正文及附件下载
      POST
    • 3.11 通过fileKey下载文件
      GET
    • 3.15 通用附件上传接口
      POST
    • 3.24 合同列表查询
      POST
    • 3.40 创建合同
      POST
    • 3.26 来源创建上传文件清空
      POST
    • 3.21 批量合同删除
      POST
    • 3.49 合同修改及变更
      POST
    • 合同取消归档
      POST
    • 合同履约信息更新
      POST
  • 6.合同履行
    • 6.4 付款计划支付回调-新合同履行
    • 6.5 付款计划创建-新合同履行
    • 6.6 收款计划查询
    • 6.7 开票信息查询
  • 7.工作流
    • 7.1 个人待办列表查询接口
    • 7.2 个人已办列表查询接口
    • 7.4 审批拒绝指定工作流
    • 7.5 审批同意指定工作流
    • 7.7 租户已办列表查询接口
    • 3.43 外部系统审批后回调
  1. 3.合同管理

3.49 合同修改及变更

test-测试环境
https://oc-test.onecontract-cloud.com
test-测试环境
https://oc-test.onecontract-cloud.com
POST
/api/hitf/v2/rest/async/invoke/CONTRACTTAB

请求参数

Header 参数
Content-Type
string 
可选
示例值:
application/json
Authorization
string 
可选
默认值:
{{token}}
Body 参数application/json
array of:
contractInfo
object 
可选
operation
enum<string> 
针对当前记录的操作类型
必需
UPDATE、UPDATE_WITH_NULL
枚举值:
UPDATEUPDATE_WITH_NULL
id
null 
必需
otherSourceReceipt
string 
来源单据编号
必需
适用于通过API创建的合同，和创建合同API中的 sourceCode 一致,合同更新场景下，合同主键必输（otherSourceReceipt/contractSerialNumber三选一）
contractSerialNumber
string 
合同流水号
必需
可作为对外的唯一ID,合同更新场景下，合同主键必输（otherSourceReceipt/contractSerialNumber三选一）
contractName
string 
合同名称
必需
principalCode
string 
必需
principalCodeType
string 
必需
contractNumber
string 
合同编号
必需
合同更新场景下，合同主键必输（otherSourceReceipt/contractSerialNumber三选一）
sourceSystem
string 
来源系统
可选
适用于通过API创建的合同,记录来源系统
amount
string 
合同金额
必需
statusCode
string 
合同状态
必需
参考字典 310-CONTRACT_STATUS
startDate
object (date) 
合同有效期从
可选
validDateStartType=DATE时有值，2025-01-01
endDate
object (date) 
合同有效期至
可选
validDateEndType=DATE时有值，2025-01-01
validDateStartCondition
string 
有效期从条件
可选
validDateStartType=CON.时有值，对条件的描述文字
validDateEndCondition
string 
有效期至条件
可选
validDateEndType=CON.时有值，对条件的描述文字
validDateStartType
enum<string> 
合同有效期从类型
必需
DATE 表示具体日期，CON.表示按条件生效
枚举值:
DATECON.
validDateEndType
enum<string> 
合同有效期至类型
必需
DATE 表示具体日期，CON.表示按条件生效
枚举值:
DATECON.
inOutTypeCode
enum<string> 
收支类型
必需
取值集 CSYS.IN_OUT_TYPE
枚举值:
IEAN
propertyCode
enum<string> 
合同性质
必需
取值集 CCRT.PROPERTY
枚举值:
AGREEMENTORDINARY
principalName
string 
经办人名称
必需
principalNum
string 
经办人员工号
必需
principalId
string 
经办人ID
必需
支持填入手机号码、邮箱、员工 ID
departmentId
string 
签订部门ID
必需
departmentCode
string 
签订部门编码
可选
departmentName
string 
签订部门名称
可选
belongingDepartmentId
string 
归属部门ID
必需
belongingDepartmentCode
string 
归属部门编码
可选
belongingDepartmentName
string 
归属部门名称
可选
changeHeader
object 
可选
operation
enum<string> 
具体操作
必需
枚举值:
UPDATEUPDATE_WITH_NULLDELETE
id
string 
OC系统 ID
可选
当operation=UPDATE、UPDATE_WITH_NULL、DELETE 时, id或者 sourceKey 两者至少一个不能为空
sourceKey
string 
来源系统唯一性 key
可选
当operation=UPDATE、UPDATE_WITH_NULL、DELETE 时, id或者 sourceKey 两者至少一个不能为空
typeNumber
string 
变更类型
必需
contractId
string 
合同id
必需
需要进行变更的合同主键，必填（contractId、contractSourceKey、contractSerialNumber三选一）
contractSourceKey
string 
合同sourceKey
必需
需要进行变更的合同主键，必填（contractIdd、contractSourceKey、contractSerialNumber三选一）
contractSerialNumber
string 
合同流水号
必需
需要进行变更的合同主键，必填（contractId、contractSourceKey、contractSerialNumber三选一）
effectiveDate
string 
变更单生效时间
可选
agreement
string 
是否补充协议
必需
changeInfo
object 
可选
operation
enum<string> 
具体操作
必需
UPDATE（更新忽略null）、UPDATE_WITH_NULL(更新不忽略null)、ADD（新增）、DELETE（删除）
枚举值:
UPDATEUPDATE_WITH_NULLADDDELETE
sourceKey
string 
来源系统唯一性 key
必需
当operation=UPDATE、UPDATE_WITH_NULL、DELETE 时, id或者 sourceKey 两者至少一个不能为空
id
string 
OC系统 ID
必需
当operation=UPDATE、UPDATE_WITH_NULL、DELETE 时, id或者 sourceKey 两者至少一个不能为空
changeType
string 
变更类型
必需
contractId
string 
合同id
必需
需要进行变更的合同主键，必填（contractId、contractSourceKey、contractSerialNumber三选一）
contractSourceKey
string 
合同sourceKey
必需
需要进行变更的合同主键，必填（contractIdd、contractSourceKey、contractSerialNumber三选一）
contractSerialNumber
string 
合同流水号
必需
需要进行变更的合同主键，必填（contractId、contractSourceKey、contractSerialNumber三选一）
description
string 
描述
可选
deleteDraftFlag
string 
删除草稿状态下的变更信息
必需
当为 true 时删除草稿状态下的变更信息
extendInfo
object 
可选
operateType
string 
操作类型
必需
override(整体覆盖)、incremental（增量调整）
data
object 
必需
    扩展字段
string 
扩展字段
必需
由于扩展业务对象都是 扩展字段，项目上按需自行传值
documentFiles
object 
可选
operateType
string 
操作类型
必需
override(整体覆盖)、incremental（增量调整）
data
array [object {6}] 
必需
attachmentFiles
object 
可选
operateType
string 
操作类型
必需
override(整体覆盖)、incremental（增量调整）
data
array [object {7}] 
必需
associatedInfos
object 
可选
operateType
string 
操作类型
必需
override(整体覆盖)、incremental（增量调整）
data
array [object {8}] 
必需
collectionPlanJs
object 
可选
operateType
string 
操作类型
必需
override(整体覆盖)、incremental（增量调整）
data
array [object {12}] 
必需
paymentPlanJs
object 
可选
operateType
string 
操作类型
必需
override(整体覆盖)、incremental（增量调整）
data
array [object {11}] 
必需
signNodes
object 
可选
operateType
string 
操作类型
必需
override(整体覆盖)、incremental（增量调整）
data
array [object {5}] 
必需
signInformations
object 
可选
operateType
string 
操作类型
必需
override(整体覆盖)、incremental（增量调整）
data
array [object {8}] 
必需
custContractLines
object 
可选
operateType
string 
操作类型
必需
override(整体覆盖)、incremental（增量调整）
data
array [object {4}] 
必需
contractLines
object 
可选
operateType
string 
操作类型
必需
override(整体覆盖)、incremental（增量调整）
data
array [object {7}] 
必需
contractTrads
object 
可选
operateType
enum<string> 
操作类型
必需
override(整体覆盖)、incremental（增量调整）
枚举值:
incrementaloverride
data
array [object {16}] 
待操作数据
必需
示例
[
  {
    "contractInfo": {
      "operation": "UPDATE",
      "id": 320190341213332457,
      "attributeVarchar1": "TWP9",
      "contractName": "TWP2024060701精确更新9"
    },
    "extendInfo":{
      "operateType": "incremental",
      "data": {
        "operation": "UPDATE",
        "attributeDatetime1": "2024/07/26 14:31:11",
        "attributeDatetime49": "2024/07/26 14:31:11",
        "attributeDecimal51": "6666"
      }
    },
    "documentFiles": {
      "operateType": "incremental",
      "data": [
        {
          "operation": "UPDATE",
          "id": "511345",
          "sourceTemplateNumber": "20240110007"
        },
        {
          "operation": "DELETE",
          "id": "511257"
        },
        {
          "operation": "ADD",
          "sourceKey": "TWP2024061801",
          "sourceTemplateNumber": "20231213001"
        }
      ]
    },
    "contractTrads": {
      "operateType": "incremental",
      "data": [
        {
          "operation": "UPDATE",
          "id": "12267710",
          "partyNumber": "20240612006"
        },
        {
          "operation": "UPDATE",
          "id": "12267711",
          "partyNumber": "2024060601209TWP",
          "autoCreateTradingParty": true,
          "mainPartyName": "TWP测试61209",
          "accountType": "COMPANY",
          "certificateType": "24",
          "certificateNumber": "sdfasdfsdfsf61209",
          "customerSupplier": "S,C",
          "tradingContacts": [
            {
              "contactName": "T联系人",
              "contactType": "CHOPOWNER",
              "certificateType": "13",
              "certificateNumber": "huzhao",
              "nationality": "中国",
              "mobilePhone": "15386046280",
              "email": "1094790168@qq.com",
              "acquiescent": true,
              "employeeId": null,
              "active": true
            }
          ],
          "tradingBanks": [
            {
              "accountName": "T银行帐户名",
              "accountNumber": "T银行帐号",
              "bankName": "T银行名称",
              "branchName": "T支行名称",
              "interBankNo": "102110006579",
              "branchCountry": "中国",
              "branchProvince": "山西",
              "branchCity": "长治市",
              "branchAddress": "T支行地址",
              "acquiescent": true,
              "active": true
            }
          ]
        },
        {
          "operation": "ADD",
          "sourceKey": "TWP2024061207sourceKey",
          "partyNumber": "20240606006",
          "roleCode": "W",
          "roleOrder": "1",
          "ourParty": false,
          "ourFlag": false,
          "signatoryFlag": false
        }
      ]
    },
    "contractLines": {
      "operateType": "incremental",
      "data": [
        {
          "operation": "ADD",
          "sourceKey": "TWP2024062001",
          "attributeLongtext1": "twplongtext1",
          "attributeDatetime2": "2024/06/20 15:47:01",
          "attributeDecimal3": "20.20",
          "materialsCode": "20240620010",
          "quantity": "11",
          "materialsName": "20240620010"
        }
      ]
    },
    "custContractLines": {
      "operateType": "incremental",
      "data": [
        {
          "operation": "ADD",
          "sourceKey": "TWP2024062001",
          "attributeLongtext1": "twpcustlongtext1",
          "attributeDatetime2": "2024/06/19 15:47:01",
          "attributeDecimal3": "19.19",
          "customLineCode": "HCBM_CONTRACT_CUST_LINE_TABLE_FZ"
        }
      ]
    },
    "signInformations": {
      "operateType": "incremental",
      "data": [
        {
          "operation": "ADD",
          "sourceKey": "TWP2024061902",
          "sealMaterial": "PHYSICALSEAL",
          "sealOrder": "DISORDER",
          "signCount": "11",
          "remark": "TWP2"
        }
      ]
    },
    "signNodes":{
      "operateType": "incremental",
      "data": [
        {
          "operation": "ADD",
          "sourceKey": "TWP2024062001",
          "employeeNumber": "0001",
          "partyNumber": "A20240730006"
        }
      ]
    },
    "paymentPlanJs":{
      "operateType": "incremental",
      "data": [
        {
          "operation": "ADD",
          "sourceKey": "JYY2024062001003",
          "planType": "CYCLE",
          "expenseItem": "SERVICE",
          "paymentName": "RENT",
          "totalAmount": "1000",
          "planStartDate": "2024-07-30",
          "planEndDate": "2025-07-30",
          "dimensionality": "MONTH",
          "periodInterval": "1"
        }
      ]
    },
    "collectionPlanJs":{
      "operateType": "incremental",
      "data": [
        {
          "operation": "ADD",
          "sourceKey": "TWP202402001005",
          "planType": "ACYCLIC",
          "termCategoryCode": "SERVICE",
          "paymentName": "EQUIPMENT_VALUE",
          "planDate": "2024-07-31",
          "planAmount": 2060,
          "totalAmount": 2060,
          "noTaxAmount": 2000,
          "taxRate": 3,
          "period": 2,
          "terms": "收款条件001"
        }
      ]
    },
    "associatedInfos":{
      "operateType": "incremental",
      "data": [
        {
          "operation": "ADD",
          "sourceKey": "JYY2024073101003",
          "relContractSerialNumber": "A20240722124",
          "relContractNumber": "A20240722125",
          "relContractId": "320190341213344341",
          "typeCode": "GC"
        }
      ]
    },
    "resources": {
      "operateType": "incremental",
      "data": [
        {
          "operation": "UPDATE",
          "sourceKey": "twp-resource-2024081903",
          "resourceNumber": "A20220718029",
          "resourceTotal": "12.21"
        },
        {
          "operation": "ADD",
          "sourceKey": "twp-resource-2024081904",
          "resourceNumber": "A20230421003"
        }
      ]
    },
    "attachmentFiles": {
      "operateType": "incremental",
      "data": [
        {
          "operation": "UPDATE",
          "sourceKey": "twp-attachment-2024081903",
          "fileName": "attachment.docx"
        },
        {
          "operation": "ADD",
          "sourceKey": "twp-attachment-2024081904",
          "attachmentNumber": "1733294867622",
          "fileKey": "hcbm-mdata-attachments/636/HUAWEI_CLOUD/d4b92fc7148e480eabc3ccf12370b254@attach1.docx",
          "fileName": "attach1.docx",
          "needArchive": false,
          "needSignature": false
        }
      ]
    }
  }
]

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST 'https://oc-test.onecontract-cloud.com/api/hitf/v2/rest/async/invoke/CONTRACTTAB' \
--header 'Authorization: bearer eb2446a6-93f9-456b-b713-5cb6f6adf765' \
--header 'Content-Type: application/json' \
--data-raw '[
  {
    "contractInfo": {
      "operation": "UPDATE",
      "id": 320190341213332457,
      "attributeVarchar1": "TWP9",
      "contractName": "TWP2024060701精确更新9"
    },
    "extendInfo":{
      "operateType": "incremental",
      "data": {
        "operation": "UPDATE",
        "attributeDatetime1": "2024/07/26 14:31:11",
        "attributeDatetime49": "2024/07/26 14:31:11",
        "attributeDecimal51": "6666"
      }
    },
    "documentFiles": {
      "operateType": "incremental",
      "data": [
        {
          "operation": "UPDATE",
          "id": "511345",
          "sourceTemplateNumber": "20240110007"
        },
        {
          "operation": "DELETE",
          "id": "511257"
        },
        {
          "operation": "ADD",
          "sourceKey": "TWP2024061801",
          "sourceTemplateNumber": "20231213001"
        }
      ]
    },
    "contractTrads": {
      "operateType": "incremental",
      "data": [
        {
          "operation": "UPDATE",
          "id": "12267710",
          "partyNumber": "20240612006"
        },
        {
          "operation": "UPDATE",
          "id": "12267711",
          "partyNumber": "2024060601209TWP",
          "autoCreateTradingParty": true,
          "mainPartyName": "TWP测试61209",
          "accountType": "COMPANY",
          "certificateType": "24",
          "certificateNumber": "sdfasdfsdfsf61209",
          "customerSupplier": "S,C",
          "tradingContacts": [
            {
              "contactName": "T联系人",
              "contactType": "CHOPOWNER",
              "certificateType": "13",
              "certificateNumber": "huzhao",
              "nationality": "中国",
              "mobilePhone": "15386046280",
              "email": "1094790168@qq.com",
              "acquiescent": true,
              "employeeId": null,
              "active": true
            }
          ],
          "tradingBanks": [
            {
              "accountName": "T银行帐户名",
              "accountNumber": "T银行帐号",
              "bankName": "T银行名称",
              "branchName": "T支行名称",
              "interBankNo": "102110006579",
              "branchCountry": "中国",
              "branchProvince": "山西",
              "branchCity": "长治市",
              "branchAddress": "T支行地址",
              "acquiescent": true,
              "active": true
            }
          ]
        },
        {
          "operation": "ADD",
          "sourceKey": "TWP2024061207sourceKey",
          "partyNumber": "20240606006",
          "roleCode": "W",
          "roleOrder": "1",
          "ourParty": false,
          "ourFlag": false,
          "signatoryFlag": false
        }
      ]
    },
    "contractLines": {
      "operateType": "incremental",
      "data": [
        {
          "operation": "ADD",
          "sourceKey": "TWP2024062001",
          "attributeLongtext1": "twplongtext1",
          "attributeDatetime2": "2024/06/20 15:47:01",
          "attributeDecimal3": "20.20",
          "materialsCode": "20240620010",
          "quantity": "11",
          "materialsName": "20240620010"
        }
      ]
    },
    "custContractLines": {
      "operateType": "incremental",
      "data": [
        {
          "operation": "ADD",
          "sourceKey": "TWP2024062001",
          "attributeLongtext1": "twpcustlongtext1",
          "attributeDatetime2": "2024/06/19 15:47:01",
          "attributeDecimal3": "19.19",
          "customLineCode": "HCBM_CONTRACT_CUST_LINE_TABLE_FZ"
        }
      ]
    },
    "signInformations": {
      "operateType": "incremental",
      "data": [
        {
          "operation": "ADD",
          "sourceKey": "TWP2024061902",
          "sealMaterial": "PHYSICALSEAL",
          "sealOrder": "DISORDER",
          "signCount": "11",
          "remark": "TWP2"
        }
      ]
    },
    "signNodes":{
      "operateType": "incremental",
      "data": [
        {
          "operation": "ADD",
          "sourceKey": "TWP2024062001",
          "employeeNumber": "0001",
          "partyNumber": "A20240730006"
        }
      ]
    },
    "paymentPlanJs":{
      "operateType": "incremental",
      "data": [
        {
          "operation": "ADD",
          "sourceKey": "JYY2024062001003",
          "planType": "CYCLE",
          "expenseItem": "SERVICE",
          "paymentName": "RENT",
          "totalAmount": "1000",
          "planStartDate": "2024-07-30",
          "planEndDate": "2025-07-30",
          "dimensionality": "MONTH",
          "periodInterval": "1"
        }
      ]
    },
    "collectionPlanJs":{
      "operateType": "incremental",
      "data": [
        {
          "operation": "ADD",
          "sourceKey": "TWP202402001005",
          "planType": "ACYCLIC",
          "termCategoryCode": "SERVICE",
          "paymentName": "EQUIPMENT_VALUE",
          "planDate": "2024-07-31",
          "planAmount": 2060,
          "totalAmount": 2060,
          "noTaxAmount": 2000,
          "taxRate": 3,
          "period": 2,
          "terms": "收款条件001"
        }
      ]
    },
    "associatedInfos":{
      "operateType": "incremental",
      "data": [
        {
          "operation": "ADD",
          "sourceKey": "JYY2024073101003",
          "relContractSerialNumber": "A20240722124",
          "relContractNumber": "A20240722125",
          "relContractId": "320190341213344341",
          "typeCode": "GC"
        }
      ]
    },
    "resources": {
      "operateType": "incremental",
      "data": [
        {
          "operation": "UPDATE",
          "sourceKey": "twp-resource-2024081903",
          "resourceNumber": "A20220718029",
          "resourceTotal": "12.21"
        },
        {
          "operation": "ADD",
          "sourceKey": "twp-resource-2024081904",
          "resourceNumber": "A20230421003"
        }
      ]
    },
    "attachmentFiles": {
      "operateType": "incremental",
      "data": [
        {
          "operation": "UPDATE",
          "sourceKey": "twp-attachment-2024081903",
          "fileName": "attachment.docx"
        },
        {
          "operation": "ADD",
          "sourceKey": "twp-attachment-2024081904",
          "attachmentNumber": "1733294867622",
          "fileKey": "hcbm-mdata-attachments/636/HUAWEI_CLOUD/d4b92fc7148e480eabc3ccf12370b254@attach1.docx",
          "fileName": "attach1.docx",
          "needArchive": false,
          "needSignature": false
        }
      ]
    }
  }
]'

返回响应

🟢200成功
application/json
Body
code
string 
业务编码
必需
data
object 
业务数据
必需
batchId
string 
批次ID
必需
message
string 
业务处理信息
必需
示例
{
    "code": "0",
    "data": {
        "batchId": "401f4357-52c5-4a1c-b5ac-7b2cde71183a"
    },
    "message": "成功"
}
上一页
3.21 批量合同删除
下一页
合同取消归档
Built with