1. 创建合同
甄零开放平台
  • 开发者指南
    • 开发者指南(必读)
    • 集成示例(必读)
    • 错误码
    • 数据字典
    • 更新日志
  • 1.认证及授权
    • 1.1 获取 Token
      POST
    • 查询异步接口处理状态
      GET
  • 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.1 创建合同
        POST
      • 3.2 合同创建进度查询
        POST
      • 3.3 清理合同上传的文件
        POST
      • 3.4 合同文件上传
        POST
    • 查询合同关联数据
      • 3.24 合同列表查询
      • 3.25 合同详情查询
      • 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.50 查询合同自定义域变量
    • 变更合同[3.45-3.48]
      • 3.19 查询合同是否存在在途的变更
      • 3.45 合同老变更删除
      • 3.46 合同新变更删除
      • 3.47 旧变更提交校验接口
      • 3.48 是否可发起新变更校验接口
    • 文件操作
      • 3.11 通过fileKey下载文件
      • 3.15 通用附件上传接口
      • 3.51 批量下载文件
      • 3.52 获取文件下载链接
    • 3.6 模板变量查询
      POST
    • 3.7 合同正文及附件下载
      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 租户已办列表查询接口
    • 7.8 外部系统审批后回调
  • 数据模型
    • 创建合同-关联对象
      • 创建合同-合同相对方
      • 创建合同-合同行
      • 创建合同-自定义合同行
      • 创建合同-签约信息
      • 创建合同-签约节点信息
      • 创建合同-合同关联关系
      • 创建合同-收款计划
      • 创建合同-付款计划
      • 创建合同-拓展信息
      • 自定义域变量
    • 合同
      • 合同查询-合同对象
      • 合同关联对象查询参数
    • 主数据
      • 物料
    • 工作流
      • 工作流任务
    • 用户上下文
    • date
    • 通用返回结构
  1. 创建合同

3.1 创建合同

test-测试环境
https://oc-test.onecontract-cloud.com
test-测试环境
https://oc-test.onecontract-cloud.com
POST
/api/hitf/v2/rest/async/invoke/SOURCE_HEADER
合同自动创建接口,可基于上游系统「来源单据」自动创建合同,合同信息包括合同头、相对方、合同行、自定义合同行、收付款计划、签约信息、关联关系、合同文本等内容。
创建合同步骤如下:
1.通过 3.4 合同文件上传 上传合同相关的附件。
2.调用本接口 3.1 创建合同 【异步】创建合同。
3.通过 3.2 合同创建进度查询 查询合同创建进度
其他场景:
1.
合同创建后,若需要替换或删除合同文件,可通过 3.3 清理合同上传的文件 先清空合同全部文件,再通过 3.4 合同文件上传 重新上传文件。

错误码如下#

错误编码错误描述备注
500101缺少用户标识或用户标识类型补充用户标识及标识类型后重新推送。
500102字段内容超过最大长度根据返回的定位字段缩短内容后重新推送。
500103缺少必填字段补齐对应模块的必填字段;金额为空等已映射的必填校验也可能返回此码。
500201指定用户不存在检查当前租户下的用户是否已创建或同步;完成维护后重新推送。
500202签订部门不存在核对当前租户的签订部门编码和编码类型,修正后重新推送。
500203业务归属部门不存在核对业务归属部门编码和编码类型;定位数据可包含出错编码及编码类型。
500204经办人不存在核对经办人工号或用户标识及对应编码类型,修正后重新推送。
500205合同分类不存在核对合同分类编码或标识;先建立有效分类后重新推送。
500206合同分类已停用启用合同分类,或改用已启用的合同分类。
500207员工不存在先同步该员工,或改用已存在的员工;定位数据可包含员工工号。
500208关联类型不存在核对关联合同类型编码,修正后重新推送。
500209关联类型已停用启用对应关联类型,或改用有效的关联类型。
500210相对方信息不存在核对相对方标识与主数据;定位数据可包含相对方编码及编码类型。
500211签订主体不存在或未启用核对签订主体编码及启用状态,修正后重新推送。
500212签订主体不能为空补充签订主体信息后重新推送。
500213相对方主数据查询失败包括相对方数据或联系人查询失败;可稍后重试,持续失败时携带 traceId 联系管理员。
500214相对方必填信息缺失(角色或名称)补齐相对方角色、名称等必填信息后重新推送。
500215相对方重复去掉重复的相对方后重新推送。
500216同一角色下的相对方顺序重复修正同一角色下的相对方顺序后重新推送。
500217我方主签约方必须且只能有一个检查我方主签约方配置,确保有且只有一个。
500218电子签章相对方缺少联系人信息为电子签章相对方补充联系人及联系方式后重新推送。
500219关联类型与关联合同重复去掉重复的合同关联关系后重新推送。
500301合同正文或模板缺失补充合同正文或有效模板后重新推送。
500302合同性质与模板不匹配修正合同性质,或调整模板允许的合同性质。
500303合同分类与模板不匹配修正合同分类,或调整模板允许的合同分类。
500304待签相对方缺少签署节点为每个需要签署的相对方补齐签署节点;确实无需签署的相对方,应明确传入 signatoryFlag=false。
500305公司签章位置不合法公司签章需具有非骑缝章签署位置,不能仅配置骑缝章位置。
500306个人签署位置缺失为个人签署节点补充签署位置后重新推送。
500307签署节点包含不需要签署的相对方删除多余签署节点,或修正节点对应的相对方标识。
500308计划收款合计超过合同金额调整计划收款合计,使其不超过合同金额。
500311合同已创建,但签约申请因签署相对方与签署节点不一致而失败先核对原合同是否已有签约申请;确无申请时,在原合同补录全部待签相对方。勿重新推送来源单创建合同。
500312合同已创建,但签约服务返回了未归类的错误先核对原合同是否已有签约申请;携带来源单号及合同标识联系管理员。勿重复创建合同。
500313合同已创建,但所选电签平台没有可用的电签账号维护对应平台的有效电签账号后,在 OC 系统提交已创建合同。勿重新推送创建第二份合同。
500314合同已创建,但自动提交未通过业务校验按具体原因修改已创建合同并在 OC 系统提交;如需重新创建,应先作废原合同。
500315来源创建未通过业务校验未映射到专用错误码的业务校验兜底;以具体原因及 businessKey 为准。重推前先核对是否已有合同。
500320需签署的文件数量超过上限{0}{0}为数量上限;减少需签署文件数量后重新推送。定位数据可包含 maxFileCount。
500321单份文件大小超过上限{0}MB{0}为单文件大小上限;压缩文件后重新推送。定位数据可包含 maxSingleFileSizeMb。
500322单份合同文件总容量超过上限{0}MB{0}为文件总容量上限;减少或压缩文件后重新推送。定位数据可包含 maxTotalFileSizeMb。
500323物料已失效改用有效物料后重新推送;定位数据可包含物料编码。
500324未找到对应的扩展对象数据核对扩展字段及扩展对象配置后重新推送。
500325模板记录不存在核对报文中的模板标识,或先建立该模板后重新推送。
500326单据预检数据未就绪(正文/模板/附件)可稍后重试;持续失败时携带 traceId 联系管理员。
500327报文字段类型非法核对定位字段的取值类型、格式及转换要求后重新推送。
500328未匹配到正文,无法记录自定义域变量核对报文中的正文与自定义域变量配置后重新推送。
500330计划收款比例合计超过100%调整计划收款比例合计至100%以内。
500331付款计划金额合计超过所关联合同行金额调整付款计划金额或对应合同行金额后重新推送。
500332付款计划金额合计超过合同总金额调整付款计划金额,使其不超过合同总金额。
500333计划类型不能为空补充计划类型后重新推送。
500334计划金额不能为空补充计划金额后重新推送;包括周期性计划金额缺失。
500335计划开始或截止日期非法检查日期是否缺失,以及开始日期、截止日期的先后关系。
500336周期性拆分参数非法(周期或金额)核对合同周期、金额及周期性拆分要求后重新推送。
500337行维度下收款计划缺少合同行为收款计划补充对应合同行后重新推送。
500338合同金额或收款计划金额异常核对合同金额与收款计划金额,修正后重新推送。
500401来源单正在处理中当前来源单尚未处理完成,应稍后查询进度,勿直接重复创建。
500402该来源单已经创建合同使用已创建合同;如需变更,应走对应更新或重建入口。
500403相同来源键的报文内容已变化已定义的冲突码;当前来源创建代码及脚本快照未确认实际触发点,不能据此认定已实现报文指纹冲突校验。
500501Redis队列投递失败PROCESS脚本文案为“异步创建任务投递失败”;先查询处理进度,再决定是否重试,持续失败时携带 traceId 联系管理员。
500502异步处理超时PROCESS脚本文案为“创建逻辑执行超时”;脚本轮询超过900000毫秒(15分钟)会返回此码。超时不等于合同一定未创建,应先查进度。
500504模板变量提取失败已定义下游错误映射;可稍后重试,持续失败时携带 traceId 联系管理员。本次未验证实际触发。
500505数据写入失败,请联系管理员包括附件、付款计划、收款计划、相对方、关联关系、合同行等内部模型化或创建失败;可识别的内层业务原因优先返回对应业务码。勿盲目重复推送。
500506后置处理类未配置联系管理员配置后置处理类后重新处理。
500507没有该合同的权限使用有权限的账号,或联系管理员授权。
500508下游服务响应无法解析包括下游响应翻译、Feign或JSON解析失败;先查询处理结果,持续失败时携带 traceId 联系管理员。
500509下游服务调用失败实际文案可附带下游返回的具体失败原因;先查询处理结果,持续失败时携带 traceId 联系管理员。
500601未找到处理记录核对来源系统及来源单号;刚推送时可稍后重查。实际文案可包含具体来源系统和来源单号。
500602处理试次状态冲突已定义;当前来源创建链路及脚本快照未确认实际触发点。标准处理建议为携带 attemptId 查询指定处理试次。
500603进度查询服务执行失败脚本及Controller可返回“进度查询失败,请稍后重试或联系管理员”;脚本在持久化结果无法按attemptId对应接口记录时,也返回此码,文案为“中间表返回结果与接口记录无法对应”。需结合具体文案区分。
509998历史记录未保存结构化错误用于未保留详细编码的历史失败记录;原始错误文案可保留,不能仅凭此码判断具体业务原因。
509999未归类的系统异常未命中专用码时的系统兜底;可安全展示时保留原始失败信息,携带 traceId 联系管理员。

请求参数

Header 参数

Body 参数application/json

示例
{
    "data": [
        {
            "autoCreateFlag": true,
            "autoSubmit": true,
            "operateMethod": "",
            "sourceCode": "DEMO_20250101008",
            "sourceSystem": "oms",
            "contractName": "采购合同",
            "type": "oms",
            "categoryUuid": "",
            "categoryCode": "0101",
            "categoryCodeType": "CODE",
            "templateUniqueKey": "",
            "templateUniqueKeyType": "",
            "propertyCode": "ORDINARY",
            "amount": "1000.12",
            "validDateStartType": "DATE",
            "startDate": "2025-01-01",
            "validDateEndType": "DATE",
            "endDate": "2050-01-01",
            "validFlag": "",
            "sourceName": "",
            "principalId": "",
            "principalCode": "0001",
            "principalCodeType": "CODE",
            "departmentId": "",
            "departmentCode": "1001",
            "departmentCodeType": "CODE",
            "belongingDepartmentId": "",
            "belongingDepartmentCode": "1001",
            "belongingDepartmentCodeType": "CODE",
            "reCreateNewContract": false,
            "userId": "",
            "userCode": "zhenling_openapi_admin",
            "userCodeType": "LOGIN_NAME",
            "childList": [
                {
                    "childType": "partyInformation",
                    "data": [
                        {
                            "roleCode": "J",
                            "roleOrder": "1",
                            "partyNumber": "91310115MA1K4PGE3T",
                            "ourFlag": "true",
                            "ourParty": "true",
                            "sourceKey": ""
                        },
                        {
                            "roleCode": "Y",
                            "roleOrder": "2",
                            "partyNumber": "91330108MAD23G379L",
                            "ourFlag": "false",
                            "ourParty": "false",
                            "sourceKey": ""
                        }
                    ]
                },
                {
                    "childType": "contractLine",
                    "data": [
                        {
                            "price": 100.123456,
                            "quantity": 1,
                            "materialsCode": ""
                        }
                    ]
                },
                {
                    "childType": "custContractLine",
                    "data": [
                        {
                            "customLineCode": "materials",
                            "item": "物品",
                            "attributeVarchar1": "物品描述"
                        }
                    ]
                },
                {
                    "childType": "associatedInfo",
                    "data": [
                        {
                            "relContractSerialNumber": "202504080001",
                            "relContractNumber": "CON_0120250408001",
                            "typeCode": "SC"
                        }
                    ]
                },
                {
                    "childType": "signInformation",
                    "data": [
                        {
                            "sealOrder": "OSF",
                            "sealMaterial": "PHYSICALSEAL",
                            "signCount": 2,
                            "deadline": ""
                        }
                    ]
                },
                {
                    "childType": "signNode",
                    "data": [
                        {
                            "partyNumber": "91310115MA1K4PGE3T",
                            "partyNumberType": "CODE",
                            "signatoryEmpCode": "0001",
                            "signatoryEmpCodeType": "CODE"
                        },
                        {
                            "partyNumber": "91330108MAD23G379L",
                            "partyNumberType": "CODE",
                            "signatoryName": "李四"
                        }
                    ]
                },
                {
                    "childType": "collectionPlanJ",
                    "data": [
                        {
                            "planType": "ACYCLIC",
                            "totalAmount": 100,
                            "planStartDate": "2025-01-01",
                            "planEndDate": "2025-12-31"
                        }
                    ]
                },
                {
                    "childType": "custVariable",
                    "data": [
                        {
                            "fieldName": "印花税",
                            "fieldValue": "loan",
                            "isEditable": "0"
                        },
                        {
                            "fieldName": "datetime",
                            "fieldValue": "2025-11-16 09:51:54",
                            "isEditable": "0"
                        }
                    ]
                }
            ]
        }
    ]
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location 'https://oc-test.onecontract-cloud.com/api/hitf/v2/rest/async/invoke/SOURCE_HEADER' \
--header 'Authorization: bearer eb2446a6-93f9-456b-b713-5cb6f6adf765' \
--header 'Authorization: bearer eb2446a6-93f9-456b-b713-5cb6f6adf765' \
--header 'Content-Type: application/json' \
--data '{
    "data": [
        {
            "autoCreateFlag": true,
            "autoSubmit": true,
            "operateMethod": "",
            "sourceCode": "DEMO_20250101008",
            "sourceSystem": "oms",
            "contractName": "采购合同",
            "type": "oms",
            "categoryUuid": "",
            "categoryCode": "0101",
            "categoryCodeType": "CODE",
            "templateUniqueKey": "",
            "templateUniqueKeyType": "",
            "propertyCode": "ORDINARY",
            "amount": "1000.12",
            "validDateStartType": "DATE",
            "startDate": "2025-01-01",
            "validDateEndType": "DATE",
            "endDate": "2050-01-01",
            "validFlag": "",
            "sourceName": "",
            "principalId": "",
            "principalCode": "0001",
            "principalCodeType": "CODE",
            "departmentId": "",
            "departmentCode": "1001",
            "departmentCodeType": "CODE",
            "belongingDepartmentId": "",
            "belongingDepartmentCode": "1001",
            "belongingDepartmentCodeType": "CODE",
            "reCreateNewContract": false,
            "userId": "",
            "userCode": "zhenling_openapi_admin",
            "userCodeType": "LOGIN_NAME",
            "childList": [
                {
                    "childType": "partyInformation",
                    "data": [
                        {
                            "roleCode": "J",
                            "roleOrder": "1",
                            "partyNumber": "91310115MA1K4PGE3T",
                            "ourFlag": "true",
                            "ourParty": "true",
                            "sourceKey": ""
                        },
                        {
                            "roleCode": "Y",
                            "roleOrder": "2",
                            "partyNumber": "91330108MAD23G379L",
                            "ourFlag": "false",
                            "ourParty": "false",
                            "sourceKey": ""
                        }
                    ]
                },
                {
                    "childType": "contractLine",
                    "data": [
                        {
                            "price": 100.123456,
                            "quantity": 1,
                            "materialsCode": ""
                        }
                    ]
                },
                {
                    "childType": "custContractLine",
                    "data": [
                        {
                            "customLineCode": "materials",
                            "item": "物品",
                            "attributeVarchar1": "物品描述"
                        }
                    ]
                },
                {
                    "childType": "associatedInfo",
                    "data": [
                        {
                            "relContractSerialNumber": "202504080001",
                            "relContractNumber": "CON_0120250408001",
                            "typeCode": "SC"
                        }
                    ]
                },
                {
                    "childType": "signInformation",
                    "data": [
                        {
                            "sealOrder": "OSF",
                            "sealMaterial": "PHYSICALSEAL",
                            "signCount": 2,
                            "deadline": ""
                        }
                    ]
                },
                {
                    "childType": "signNode",
                    "data": [
                        {
                            "partyNumber": "91310115MA1K4PGE3T",
                            "partyNumberType": "CODE",
                            "signatoryEmpCode": "0001",
                            "signatoryEmpCodeType": "CODE"
                        },
                        {
                            "partyNumber": "91330108MAD23G379L",
                            "partyNumberType": "CODE",
                            "signatoryName": "李四"
                        }
                    ]
                },
                {
                    "childType": "collectionPlanJ",
                    "data": [
                        {
                            "planType": "ACYCLIC",
                            "totalAmount": 100,
                            "planStartDate": "2025-01-01",
                            "planEndDate": "2025-12-31"
                        }
                    ]
                },
                {
                    "childType": "custVariable",
                    "data": [
                        {
                            "fieldName": "印花税",
                            "fieldValue": "loan",
                            "isEditable": "0"
                        },
                        {
                            "fieldName": "datetime",
                            "fieldValue": "2025-11-16 09:51:54",
                            "isEditable": "0"
                        }
                    ]
                }
            ]
        }
    ]
}'

返回响应

🟢200成功
application/json
Bodyapplication/json

示例
{
    "code": "100250",
    "data": {
        "results": [
            {
                "endDate": "2050-01-01",
                "validFlag": "",
                "sourceSystem": "oms",
                "departmentId": "",
                "departmentCode": "1001",
                "principalId": "",
                "childList": [
                    {
                        "childType": "partyInformation",
                        "data": [
                            {
                                "sourceKey": "",
                                "ourParty": "true",
                                "roleCode": "J",
                                "ourFlag": "true",
                                "roleOrder": "1",
                                "partyNumber": "91310115MA1K4PGE3T"
                            },
                            {
                                "sourceKey": "",
                                "ourParty": "false",
                                "roleCode": "Y",
                                "ourFlag": "false",
                                "roleOrder": "2",
                                "partyNumber": "91330108MAD23G379L"
                            }
                        ]
                    },
                    {
                        "childType": "contractLine",
                        "data": [
                            {
                                "quantity": "1",
                                "price": "100.123456",
                                "materialsCode": ""
                            }
                        ]
                    },
                    {
                        "childType": "custContractLine",
                        "data": [
                            {
                                "item": "物品",
                                "customLineCode": "materials",
                                "attributeVarchar1": "物品描述"
                            }
                        ]
                    },
                    {
                        "childType": "associatedInfo",
                        "data": [
                            {
                                "relContractSerialNumber": "202504080001",
                                "relContractNumber": "CON_0120250408001",
                                "typeCode": "SC"
                            }
                        ]
                    },
                    {
                        "childType": "signInformation",
                        "data": [
                            {
                                "signCount": "2",
                                "sealOrder": "OSF",
                                "sealMaterial": "PHYSICALSEAL",
                                "deadline": ""
                            }
                        ]
                    },
                    {
                        "childType": "signNode",
                        "data": [
                            {
                                "signatoryEmpCodeType": "CODE",
                                "partyNumberType": "CODE",
                                "signatoryEmpCode": "0001",
                                "partyNumber": "91310115MA1K4PGE3T"
                            },
                            {
                                "partyNumberType": "CODE",
                                "signatoryName": "李四",
                                "partyNumber": "91330108MAD23G379L"
                            }
                        ]
                    },
                    {
                        "childType": "collectionPlanJ",
                        "data": [
                            {
                                "totalAmount": "100",
                                "planType": "ACYCLIC",
                                "planStartDate": "2025-01-01",
                                "planEndDate": "2025-12-31"
                            }
                        ]
                    }
                ],
                "type": "oms",
                "userCodeType": "LOGIN_NAME",
                "userCode": "zhenling_openapi_admin",
                "autoSubmit": true,
                "sourceCode": "DEMO_20250101007",
                "propertyCode": "ORDINARY",
                "validDateStartType": "DATE",
                "principalCode": "0001",
                "subCode": "500003",
                "belongingDepartmentCode": "1001",
                "departmentCodeType": "CODE",
                "validDateEndType": "DATE",
                "belongingDepartmentId": "",
                "templateUniqueKeyType": "",
                "amount": "1000.12",
                "operateMethod": "",
                "categoryCode": "0101",
                "autoCreateFlag": true,
                "principalCodeType": "CODE",
                "reCreateNewContract": false,
                "userId": "",
                "categoryCodeType": "CODE",
                "categoryUuid": "",
                "templateUniqueKey": "",
                "belongingDepartmentCodeType": "CODE",
                "sourceName": "",
                "subMessage": "[DEMO_20250101007]来源单数据已经创建了非草稿状态的合同, 需要先作废已存在合同再来源创建",
                "startDate": "2025-01-01"
            }
        ]
    },
    "message": "简单校验失败"
}
上一页
5.3 物料创建及更新
下一页
3.2 合同创建进度查询
Built with