甄零开放平台
  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.6 模板变量查询

test-测试环境
https://oc-test.onecontract-cloud.com
test-测试环境
https://oc-test.onecontract-cloud.com
POST
/api/hitf/v2p/rest/invoke/SFpFUk86T1JDSEVTVFJBVElPTjpISVRGLkFQSS5EQVRBX1FVRVJZ
使用场景: 查询合同正文模版变量参数

请求参数

Query 参数
userIdType
string 
必需
userId类型,userIdType=EMAIL时填邮箱,userIdType=USERID时填合同系统的USERID,userIdType=LOGINNAME时填合同系统的登录名
示例值:
LOGINNAME
userId
string 
必需
userId,LOGINNAME 登录账号, EMAIL 邮箱, USERID 合同系统用户ID
示例值:
zhenling_openapi_admin
domain
string 
必需
示例值:
TEMPLATE_VARIABLE
Header 参数
Authorization
string 
可选
默认值:
{{token}}
Body 参数application/json
templateUniqueKey
string 
合同模版uuid
必需
可通过【3.10 合同模板查询】先查询合同模板列表,使用其中的 templateUuid 作为参数
示例
{
    "templateUniqueKey": "2a0b514b083c4244ad77667227101f01"
}

示例代码

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/v2p/rest/invoke/SFpFUk86T1JDSEVTVFJBVElPTjpISVRGLkFQSS5EQVRBX1FVRVJZ?userIdType=LOGINNAME&userId=zhenling_openapi_admin&domain=TEMPLATE_VARIABLE' \
--header 'Authorization: bearer eb2446a6-93f9-456b-b713-5cb6f6adf765' \
--header 'Content-Type: application/json' \
--data-raw '{
    "templateUniqueKey": "2a0b514b083c4244ad77667227101f01"
}'

返回响应

🟢200成功
application/json
Body
message
string 
接口响应信息
必需
result
object 
接口响应数据
必需
errcode
string 
业务响应编码
必需
0代表处理成功
errmsg
string 
业务响应信息
必需
data
object 
业务响应数据
必需
success
boolean 
接口是否成功
必需
示例
{
    "message": "execute success",
    "result": {
        "errcode": "0",
        "errmsg": "ok",
        "data": {
            "totalElements": 38,
            "content": [
                {
                    "uuid": "be4cf917ee40433aa2e7fe9cfb9dd8d3",
                    "fieldName": "RENT*1*LC_taxRate",
                    "fieldDesc": "租金*1*税率"
                },
                {
                    "uuid": "3f781c857c9d4465b189a8ae4fe6aa2a",
                    "fieldName": "RENT*1*LC_payType",
                    "fieldDesc": "租金*1*付款方式"
                },
                {
                    "uuid": "b79e07fe5add47a7abb114bb89a93fc1",
                    "fieldName": "RENT*1*LC_payer",
                    "fieldDesc": "租金*1*收款方"
                },
                {
                    "uuid": "95ecf92a675f4da8a34cb226ff4eaa10",
                    "fieldName": "RENT*1*LC_firstPaymentDate",
                    "fieldDesc": "租金*1*首次租金付款日"
                },
                {
                    "uuid": "bfbbc7fd9c2c46f8a25b44ecda829a41",
                    "fieldName": "RENT*1*LC_secondPaymentDate",
                    "fieldDesc": "租金*1*第二次租金付款日"
                },
                {
                    "uuid": "0469fa91a9da418884abd6040a4d656a",
                    "fieldName": "RENT*1*LC_payFrequency",
                    "fieldDesc": "租金*1*付款频次"
                },
                {
                    "uuid": "011f37b8ec39460f91b1c23722c8e2fc",
                    "fieldName": "RENT*1*LC_expenseItem",
                    "fieldDesc": "租金*1*付款项目类型(租金,押金)"
                },
                {
                    "uuid": "2beb6e8b05e146bf8f2c49dffba3843c",
                    "fieldName": "RENT*1*LC_capitalAmount",
                    "fieldDesc": "租金*1*每期金额(大写)"
                },
                {
                    "uuid": "b8b9a8c1e77a4bbbb4487274e09ec372",
                    "fieldName": "RENT*1*LC_rentFreeFlag",
                    "fieldDesc": "租金*1*是否含免租期"
                },
                {
                    "uuid": "716e75277d904eb686c2d97c67f8d2d8",
                    "fieldName": "RENT*1*LC_ftMonth",
                    "fieldDesc": "租金*1*首月/尾月"
                },
                {
                    "uuid": "790ce6e7142244ebbdc5c4f82d5ec331",
                    "fieldName": "RENT*1*LC_leaseBeginDate",
                    "fieldDesc": "租金*1*租金开始日期"
                },
                {
                    "uuid": "2a59b9d1527242909c2193dbcd8e67c1",
                    "fieldName": "RENT*1*LC_leaseEndDate",
                    "fieldDesc": "租金*1*租金结束日期"
                },
                {
                    "uuid": "5babcf64c2314bb9b7501c0ab1f9217e",
                    "fieldName": "RENT*1*LC_rentFreeEndDate",
                    "fieldDesc": "租金*1*免租期结束日期"
                },
                {
                    "uuid": "b27ee23c57f94c1ba692c761cac6a94b",
                    "fieldName": "HYDROPOWER*2*LC_payFrequency",
                    "fieldDesc": "水电费*2*付款频次"
                },
                {
                    "uuid": "e8c4a62935b34d65a8cb13bf5bb12f19",
                    "fieldName": "RENT*1*LC_singleMonthFlag",
                    "fieldDesc": "租金*1*是否足月"
                },
                {
                    "uuid": "98ed4a1c8f7e4bf8a4ae2ade83bb1afe",
                    "fieldName": "RENT*1*LC_growthModel",
                    "fieldDesc": "租金*1*增长模式"
                },
                {
                    "uuid": "d9a0695ef058483abf3191aec3e4673a",
                    "fieldName": "HYDROPOWER*1*LC_firstPaymentDate",
                    "fieldDesc": "水电费*1*首次租金付款日"
                },
                {
                    "uuid": "0e079749b03441628fade4e5e334e554",
                    "fieldName": "HYDROPOWER*2*LC_capitalAmount",
                    "fieldDesc": "水电费*2*每期金额(大写)"
                },
                {
                    "uuid": "d4e4f1894ce242f7b5c4d587d74ef97a",
                    "fieldName": "RENT*1*LC_rentGrowthBeginDate",
                    "fieldDesc": "租金*1*资金增长租金日期从"
                },
                {
                    "uuid": "db1eb85beb4646a187159d26bf64b342",
                    "fieldName": "HYDROPOWER*1*LC_payType",
                    "fieldDesc": "水电费*1*付款方式"
                },
                {
                    "uuid": "44ebb3688d114954945e914079e6788b",
                    "fieldName": "HYDROPOWER*1*LC_expenseItem",
                    "fieldDesc": "水电费*1*付款项目类型(租金,押金)"
                },
                {
                    "uuid": "619be6852b3c4f438ad303a7983b857a",
                    "fieldName": "RENT*1*LC_dailyUnitPrice",
                    "fieldDesc": "租金*1*日单价"
                },
                {
                    "uuid": "05bee32c6b1b4076a45477480732372c",
                    "fieldName": "RENT*1*LC_increaseAmount",
                    "fieldDesc": "租金*1*增长金额"
                },
                {
                    "uuid": "25a1b30f617741bd8e6fc6ca5ee3b60d",
                    "fieldName": "HYDROPOWER*2*LC_amount",
                    "fieldDesc": "水电费*2*每期金额"
                },
                {
                    "uuid": "9b39da3ef8614e3daaba0c00eb3046d6",
                    "fieldName": "RENT*1*LC_growthRate",
                    "fieldDesc": "租金*1*增长比例"
                },
                {
                    "uuid": "fbdf057237394e21b8b077edc842eca1",
                    "fieldName": "RENT*1*LC_planPaymentDate",
                    "fieldDesc": "租金*1*首次增长计划付款日"
                },
                {
                    "uuid": "84185ee0443a4b9ca4a9dab88419f032",
                    "fieldName": "HYDROPOWER*1*LC_capitalAmount",
                    "fieldDesc": "水电费*1*每期金额(大写)"
                },
                {
                    "uuid": "5e06975e2c374051ada6613d9f84e6bb",
                    "fieldName": "RENT*1*LC_rentFreeBeginDate",
                    "fieldDesc": "租金*1*免租期开始日期"
                },
                {
                    "uuid": "2126a1777bdd415d83ea58df2ba720f2",
                    "fieldName": "HYDROPOWER*2*LC_expenseItem",
                    "fieldDesc": "水电费*2*付款项目类型(租金,押金)"
                },
                {
                    "uuid": "111cf971b2c042168ef333fcc2b6965b",
                    "fieldName": "HYDROPOWER*1*LC_payFrequency",
                    "fieldDesc": "水电费*1*付款频次"
                },
                {
                    "uuid": "b4ba23d16a7146e6b674c818a45a264a",
                    "fieldName": "HYDROPOWER*2*LC_payType",
                    "fieldDesc": "水电费*2*付款方式"
                },
                {
                    "uuid": "df9fc798a8be4c9b846b67da19c5ed4e",
                    "fieldName": "HYDROPOWER*1*LC_payer",
                    "fieldDesc": "水电费*1*收款方"
                },
                {
                    "uuid": "e57b4b4f83fe4f9abc5636a38e119a8d",
                    "fieldName": "RENT*1*LC_periodGrowthFlag",
                    "fieldDesc": "租金*1*是否逐期增长"
                },
                {
                    "uuid": "18aea39148394ec88acf99935b07f6ff",
                    "fieldName": "RENT*1*LC_rentGrowthEndDate",
                    "fieldDesc": "租金*1*资金增长租金日期至"
                },
                {
                    "uuid": "d95e2f0a9ca543069c3a5b14afa70b8c",
                    "fieldName": "HYDROPOWER*2*LC_firstPaymentDate",
                    "fieldDesc": "水电费*2*首次租金付款日"
                },
                {
                    "uuid": "7b6e69a187b24392be3a4bdda7665871",
                    "fieldName": "HYDROPOWER*2*LC_attributeDecimal1",
                    "fieldDesc": "水电费*2*数字"
                },
                {
                    "uuid": "6b922c157cda4824989a89556264b021",
                    "fieldName": "HYDROPOWER*1*LC_amount",
                    "fieldDesc": "水电费*1*每期金额"
                },
                {
                    "uuid": "b64b59b9ad4b4e0083def191c471c096",
                    "fieldName": "RENT*1*LC_attributeDecimal1",
                    "fieldDesc": "租金*1*数字"
                }
            ]
        }
    },
    "success": true
}
上一页
3.5 获取文件预览链接
下一页
3.7 合同正文及附件下载
Built with