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 创建合同
      • 3.2 合同创建进度查询
      • 3.3 清理合同上传的文件
      • 3.4 合同文件上传
    • 查询合同关联数据
      • 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. 开发者指南

集成示例(必读)

如何以特定用户身份访问？#

集成时默认通过 客户端模式（client_credentials）访问OC的API，不涉及到任何数据权限的控制。
若需以特定的用户身份访问接口，可以通过参数的形式指定用户上下文。
用户上下文

具体可参考 7.1 个人待办列表查询接口

如何创建一份合同？#

创建合同需要先准备好相关主数据，包含：
1.
签署部门、业务归属部门信息：可通过 4.1 组织信息创建及更新 创建部门
2.
合同经办人信息：可通过 4.2 岗位创建及更新、4.3 员工创建及更新 创建岗位、员工信息。
若集成了企微、钉钉、飞书，则可直接使用部门、员工数据。
3.上传合同相关文件：通过 3.4 合同文件上传 先上传合同的主文件和相关附件。
特别注意：sourceDocumentNumber(来源单据号) 请使用您内部系统中合同的唯一ID，该字段将与OC系统中的合同建立关联关系。
image.png
4.创建合同：通过 3.1 创建合同 创建一份合同。在请求示例中，只需要调整 sourceCode(来源单据号，和 3.4 合同文件上传 中的sourceDocumentNumber(来源单据号)一致) 即可创建一份合同，其他字段已预设好。
image.png
5.
查询处理结果
创建合同为异步接口，可通过 2 种方式查询结果。
通过定期轮询方式查询：
通过 3.2 合同创建进度查询 查询
等待合同系统主动回调
可以根据 code+subCode 判断处理状态，根据sourceSystem+sourceCode区分来源系统和单据。
image.png

如何查询合同？#

两个接口配合使用，通过合同列表查询到所有的合同基本信息数据后，再查询具体的合同详情，如果对方系统已经回写了合同编码、合同流水号也可以直接调用3.25 合同详情查询查询单个合同所有的信息
1.
查询合同列表：调用3.24 合同列表查询返回的是合同基本信息的数据（不包含其他维度数据），支持所有字段作为查询条件（条件字段放入 condition 中即可）
image.png
2.
查询单份合同的所有维度数据：调用3.25 合同详情查询，通过合同编码、合同流水号都可以作为入参，可自主控制查询任意的子维度（默认不查）
image.png

如何删除合同？#

删除合同支持：来源单据、合同编码、合同流水号作为删除的唯一性条件，调用接口3.21 批量删除合同批量删除
image.png

如何更新合同信息#

合同更新支持更新合同基本信息通过合同编码、合同流水号、来源单作为唯一性条件，也支持更新所有的行维度
1.
更新基本信息调用接口3.49 合同修改及变更, 在contractInfo中区块中指定需要更新的字段
Lark Helper 2026-08-25 09.48.00.png
2.
行维度更新
行维度更新可以使用sourceKey 或者 OC系统的行记录 ID 作为唯一性条件，建议优先使用sourceKey因为系统对接，可以通过3.1 创建合同给每一条数据指定sourceKey
行维度更新有如下几种模式
全量覆盖（删除之前的数据重新新增）
调用接口3.49 合同修改及变更在对应的行区块填入需要新增的数据
image.png
增量更新（可以对这个维度进行增删改操作）
image.png

如何发起新变更合同#

新变更发起复用了接口3.49 合同修改及变更，创建新变更需要准备变更的相关信息以及变更哪一份合同，内容维护在changeInfo区块，其他的区块就是按需你想调整哪个区块就维护那个区块的内容
1.
准备好数据后则可以调用3.49 合同修改及变更
image.png
2.
结果同步
接口本身是异步处理返回的本身是代表接口请求成功，如果需要在接口处理完成后进行相应的内容推送可以在异步接口管理 中配置，回调接口（对方系统需要提供一个接口接收相关信息），具体的操作可以参考文档异步接口说明
Apifox 2026-08-27 15.33.54.png

如何发起老变更合同#

老变更发起复用了接口3.49 合同修改及变更，创建新变更需要准备变更的相关信息以及变更哪一份合同，内容维护在changeHeader区块，其他的区块就是按需你想调整哪个区块就维护那个区块的内容
1.
准备好数据后调用3.49 合同修改及变更
image.png
2.
结果同步
接口本身是异步处理返回的本身是代表接口请求成功，如果需要在接口处理完成后进行相应的内容推送可以在异步接口管理 中配置，回调接口（对方系统需要提供一个接口接收相关信息），具体的操作可以参考文档异步接口说明

如何下载合同文件#

大文件量下载#

推荐使用场景：把一批fileKey 打包下载成一个压缩包，当前接口限制是最多同时下载 100 的 fileKey
1.
调用链路
批量下载接口为异步模式，所以触发下载后需要调用查询接口获取最终的压缩包
批量下载文件 -> 获取文件下载链接
2.
准备好所有需要下载的文件 fileKey 集合后调用批量下载文件
image.png
3.
步骤二返回了fileDlUuid，当做参数调用获取文件下载链接查询下载文件的压缩包
image.png

单个文件下载#

推荐使用场景：单个 fileKey 下载
3.11 通过fileKey下载文件
image.png
上一页
开发者指南(必读)
下一页
错误码
Built with