3.40 创建合同 - 甄零开放平台

请先通过「3.4 合同文件上传」接口上传合同相关的附件。

合同自动创建接口，可基于上游系统来源单据关键信息自动创建合同，合同信息包括合同头、相对方、合同行、自定义合同行、收付款计划、签约信息、关联关系、合同文本等内容。

在接口中可控制是否直接创建合同草稿还是创建为中间来源单据，可控制创建的合同是否自动提交，可控制合同中的相对方信息是否自动回写相对方主数据库等。
3.创建完成结果通过异步方式回调

请求参数

Header 参数

Content-Type

string

可选

示例值:

application/json

Authorization

string

可选

默认值:

Body 参数application/json

data

array [object {35}]

必需

autoCreateFlag

boolean

是否自动创建合同

必需

true 时将自动创建一份新建状态的合同；false 时仅创建一份来源单据信息，需人工选择来源单据后创建合同

autoSubmit

boolean

是否自动提交合同审批

必需

true 时将自动提交合同审批工作流，为 true 时 autoCreateFlag 必须为 true

operateMethod

enum<string>

后续操作

可选

枚举值:

ARCHIVEONLY_ARCHIVE

sourceSystem

string

来源系统代码

必需

联系甄零项目经理获取
【从OC系统的菜单[来源创建映射维护]取值】

sourceCode

string

来源单据号

必需

推荐使用您业务系统中合同的唯一键

type

string

单据类型

必需

联系甄零项目经理获取
【从OC系统的菜单[来源创建映射维护]取值】

categoryUuid

string

合同分类 uuid

必需

合同系统中的合同分类uuid，categoryUuid 和 (categoryCode+categoryCodeType) 二选一必输

categoryCode

string

合同分类编码

必需

合同系统中的合同分类编码，配合categoryCodeType使用。categoryUuid 和 (categoryCode+categoryCodeType) 二选一必输

categoryCodeType

enum<string>

合同分类编码类型

必需

合同分类编码的类型，取固定值 CODE，categoryUuid 和 (categoryCode+categoryCodeType) 二选一必输

枚举值:

CODE

templateUniqueKey

string

合同模板唯一标识

可选

基于合同模板创建时必填，非模板创建时非必填2. 此值需要配置字段templateUniqueKeyType使用

如果templateUniqueKeyType值为 ID，那么需要传入合同系统的【模板uuid】，可通过【3.10 合同模板查询】接口获取，使用响应报文中的 templateUuid

如果templateUniqueKeyType值为 CODE，那么直接传入 OC 系统的模板编码

templateUniqueKeyType

string

合同模板唯一标识的类型

可选

基于合同模板创建时必填，非模板创建时非必填

取值 CODE 或 ID

propertyCode

string

合同性质

必需

指定创建OC合同的合同性质
取值【值集CCRT.PROPERTY】
AGREEMENT 框架协议、ORDINARY 普通合同

validFlag

boolean

来源单据的有效性

可选

在来源单没有创建 OC 系统的合同之前，可以通过 validFlag 失效已经同步到 OC 系统的来源单据
取值范围（默认值为：true）：【true/false】

sourceName

string

来源单据名称

可选

自定义本次来源单据的名称，方便在 OC 系统进行查看

amount

number

合同总金额

必需

validDateStartType

enum<string>

有效期从类型

必需

枚举值:

DATECON.

validDateEndType

string

有效期至类型

必需

取值同 validDateStartType

startDate

string

有效期从

可选

2020-01-01, validDateStartType=DATE时必输

endDate

string

有效期至

可选

2020-01-01,validDateEndType=DATE时必输

validDateStartCondition

string

有效期从的条件

可选

对有效期从的文字说明

validDateEndCondition

string

有效期至的条件

可选

对有效期至的文字说明

principalId

integer

经办人 ID

必需

指定合同的经办人/负责人ID，OC 系统的员工 ID。principalId和principalCode+principalCodeType字段二选一必输

principalCode

string

经办人编码

必需

OC 系统的员工编码，配合principalCodeType使用。principalId和principalCode+principalCodeType字段二选一必输

principalCodeType

string

经办人编码编码类型

必需

OC 系统的员工编码类型，取值【CODE/ID】

CODE 【取此值时，principalCode需要传入 OC系统的合同员工编码】

ID 【取此值时，principalCode需要传入 OC系统的合同员工ID】

departmentId

integer

签订部门ID

必需

OC 系统的部门 ID，departmentId和departmentCode+departmentCodeType字段二选一必输。

departmentCode

string

签订部门编码

必需

OC 系统的部门编码，配合departmentCodeType使用

departmentCodeType

string

签订部门编码类型

必需

OC 系统的部门编码类型，取值【CODE/ID/LEVEL_PATH】

CODE 【取此值时，departmentCode需要传入 OC系统的部门编码（需要项目自行确认，部门编码是否可能重复，如果重复推荐使用 LEVEL_PATH）】

LEVEL_PATH 【取此值时，departmentCode需要传入 OC系统的levelPath】

ID 【取此值时，departmentCode需要传入 OC系统的部门 id】

belongingDepartmentId

integer

业务归属部门

必需

OC 系统的部门 ID，belongingDepartmentId和belongingDepartmentCode+belongingDepartmentCodeType字段二选一必输

belongingDepartmentCode

string

业务归属部门编码

必需

OC 系统的部门编码，配合departmentCodeType使用

belongingDepartmentCodeType

string

业务归属部门编码类型

必需

OC 系统的部门编码类型，取值【CODE/ID/LEVEL_PATH】

CODE 【取此值时，belongingDepartmentCode需要传入 OC系统的部门编码（需要项目自行确认，部门编码是否可能重复，如果重复推荐使用 LEVEL_PATH）】

LEVEL_PATH 【取此值时，belongingDepartmentCode需要传入 OC系统的levelPath】

reCreateNewContract

boolean

是否重新创建草稿状态下的合同

可选

为空或者 false 不创建，此场景下提示用户数据已经存在
为 true 时，如果此来源单的合同状态为草稿状态即新建，那么现删除已存在的合同，再次基于来源创建重新创建一份合同

userId

integer

合同创建人ID

必需

OC 系统的用户 id，用来指定合同的创建人，后续可做数据权限。userId 和 userCode+userCodeType 二选一必输

userCode

string

创建人编码

必需

为 OC 系统的登录名、邮箱

userCodeType

string

创建人编码类型

必需

配合userCode使用，取值如下：

LOGIN_NAME 【取此值时，userCode传入登录名】

EMAIL 【取此值时，userCode传入邮箱】

PHONE 取此值时，userCode传入手机号码】

ID 取此值时，userCode传入OC 系统 ID】

childList

array [object {9}]

必需

示例

{
    "data": [
        {
            "autoCreateFlag": true,
            "autoSubmit": true,
            "operateMethod": "",
            "sourceCode": "DEMO_20250101008",
            "sourceSystem": "oms",
            "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"
                        }
                    ]
                }
            ]
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://oc-test.onecontract-cloud.com/api/hitf/v2/rest/async/invoke/SOURCE_HEADER' \
--header 'Authorization: bearer eb2446a6-93f9-456b-b713-5cb6f6adf765' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": [
        {
            "autoCreateFlag": true,
            "autoSubmit": true,
            "operateMethod": "",
            "sourceCode": "DEMO_20250101008",
            "sourceSystem": "oms",
            "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"
                        }
                    ]
                }
            ]
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

code

string

状态码，0表示已受理请求，不代表合同创建成功

必需

data

object

必需

batchId

string

请求ID，可通过该请求ID排查问题

必需

message

string

必需

示例

{
    "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": "简单校验失败"
}