电子合同管理系统-对接文档
对接指南
API接口
认证
账户管理
新增开户或变更账户信息
请求授权企业静默签(线上)
请求授权企业静默签(线下)
线下授权文件上传
新增或变更企业代理签署人信息
请求授权企业代理签署人(线上)
请求授权企业代理签署人(线下)
获取账户
模版管理
添加-更新模版
预览模版-返回预览链接
预览模版-返回pdf文件流
合同管理
使用模版创建合同文档
根据合同文档编号查询合同文档的全部信息
取消合同文档签署
订阅接口
常见问题
回调/订阅通知
合同签署回调通知
企业信息变更订阅通知
本文档使用 MrDoc 发布
-
+
首页
根据合同文档编号查询合同文档的全部信息
# 接口描述 # 接口地址 `GET /admin/contract/cds/{cdsNo}` # 请求参数 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | -------- | -------- | ----- | -------- | -------- | ------ | |cdsNo||path|true|string|| **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | -------- | -------- | ----- |----- | |code|返回标记:成功标记=0,失败标记=1|integer(int32)|integer(int32)| |msg|返回信息|string|| |data||ContractDocumentDTO|ContractDocumentDTO| | contractQuantity|合同数量|integer(int32)|| | initiatorId|发起人ID,该合同文稿由该用户进行管理|integer(int64)|| | initiatorUsername|发起人用户名|string|| | initiatorName|发起人名称|string|| | initiatorDeptId|发起人部门ID|integer(int64)|| | initiatorCompanyId|发起人公司ID|integer(int64)|| | status|状态,可用值:CDD,RELEASED,INITIATED,CANCELED,SIGNED|string|| | source|来源,可用值:MANUAL,OA,TEMPLATE|string|| | client|数据来源客户端|string|| | markReason||string|| | summary||object|| | summaryText|摘要纯文本,用于全文索引|string|| | delFlag|删除标记,1:已删除,0:正常|string|| | callbackUrl|回调地址,无则不进行回调通知|string|| | contracts|合同列表|array|ContractDTO| | contractDocumentsNumber|合同文档编号|string|| | contractName|合同名称|string|| | contractNumber|合同编号|string|| | templateNumber|模版编号|string|| | status|合同状态,CDD(文稿状态)、INITIATED(已发起)、SIGNED(已签署),可用值:CDD,INITIATED,SIGNED|string|| | contractUrl|合同地址|string|| | bizData|业务数据,创建合同时传递|string|| | signedContractUrl|已签署地址|string|| | eid|证据编号|string|| | summary||object|| | scope||string|| | mandatoryReadDuration|强制阅读时长,单位秒,默认0不强制|integer(int32)|| | signatories|签署人列表|array|ContractSignatoryDTO| | signPos|签署位置|array|SignPos| | posPage|印章所在页码,坐标与骑缝章必传,支持范围页码(1-3,4,5)|string|| | posX|印章x坐标,坐标必传|number(float)|| | posY|印章y坐标,坐标与骑缝章必传|number(float)|| | keyword|关键字|string|| | type|0为坐标,1为关键字,2为骑缝章;默认为0|integer(int32)|| | signPosTag|签署位置标记(模版创建时有)|string|| | sealCode|印章code|string|| | signatoryType|签署人类型(PERSONAL/CORPORATE),可用值:PERSONAL,CORPORATE,PLATFORM|string|| | signatoryName|签署人姓名|string|| | signatoryIdNumber|签署人证件号|string|| | signatoryMobile|签署人手机号|string|| | signatoryBankcardNumber|签署人银行卡号|string|| | willingnessId|意愿认证ID|string|| | willingnessAuthWay|意愿认证方式|string|| | facePhotoUrl|签署人脸照片|string|| | agentIdNumber||string|| | agentCorporateIdNumbers||string|| | signStatus|签署状态(SIGNED/NOT_SIGNED),可用值:SIGNED,NOT_SIGNED|string|| | signTime|签署时间|string(date-time)|| | blank|为true时,将在签署时落空白章|boolean|| | reportId|存证报告ID|string|| | reportUrl|存证报告URL|string|| | seal||Seal|Seal| | entityType|主体类型,可用值:PERSONAL,CORPORATE|string|| | silently|是否静默签署,未指定时后续该印章将使用账户中的静默签配置|boolean|| | entityIdNumber|主体识别号码|string|| | entityName|主体名称|string|| | sealCode|章code,关联seal_config中的code|string|| | sealDataBase64|印章base64|string|| | text|印章文本|string|| | client|来源|string|| | color|印章颜色,可用值:RED,BLUE,BLACK|string|| | shape|印章形状,可用值:STAR,OVAL,DEDICATED,SQUARE,RECTANGLE,BORDERLESS|string|| | scope|用途|string|| | status|可用值:NOT_EFFECTIVE,EFFECTIVE|string|| | createTime||string(date-time)|| | createBy||string|| | delFlag|删除标记,1:已删除,0:正常|string|| | default||boolean|| | htext||string|| | qtext||string|| | htext||string|| | qtext||string|| |requestId||string|| |ok||boolean|| **响应示例**: ```javascript { "code": 0, "msg": "", "data": { "contractQuantity": 0, "initiatorId": 0, "initiatorUsername": "", "initiatorName": "", "initiatorDeptId": 0, "initiatorCompanyId": 0, "status": "", "source": "", "client": "", "markReason": "", "summary": {}, "summaryText": "", "delFlag": "", "callbackUrl": "", "contracts": [ { "contractDocumentsNumber": "", "contractName": "", "contractNumber": "", "templateNumber": "", "status": "", "contractUrl": "", "bizData": "", "signedContractUrl": "", "eid": "", "summary": {}, "scope": "", "mandatoryReadDuration": 0, "signatories": [ { "signPos": [ { "posPage": "", "posX": 0, "posY": 0, "keyword": "", "type": 0 } ], "signPosTag": "", "sealCode": "", "signatoryType": "", "signatoryName": "", "signatoryIdNumber": "", "signatoryMobile": "", "signatoryBankcardNumber": "", "willingnessId": "", "willingnessAuthWay": "", "facePhotoUrl": "", "agentIdNumber": "", "agentCorporateIdNumbers": "", "signStatus": "", "signTime": "", "blank": true, "reportId": "", "reportUrl": "", "seal": { "entityType": "", "silently": true, "entityIdNumber": "", "entityName": "", "sealCode": "", "sealDataBase64": "", "text": "", "client": "", "color": "", "shape": "", "scope": "", "status": "", "createTime": "", "createBy": "", "delFlag": "", "default": true, "htext": "", "qtext": "" }, "htext": "", "qtext": "" } ] } ] }, "requestId": "", "ok": true } ```
admin
2024年8月28日 18:06
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Markdown文件
PDF文档(打印)
分享
链接
类型
密码
更新密码