财务共享影像管理系统接口方案书A3国信合成

xxxx财务共享影像管理系统接口方案书深圳市国信合成科技有限公司第1页共17页保密资料编号：SiiT-YBBX20150623项目编号：SiiT-YBBX20150623内部资料，注意保密xxxx财务共享影像管理系统接口方案书深圳市国信合成科技有限公司2015年06月23日文档属性文档属性内容项目名称xxxx财务共享影像管理系统应用软件采购项目项目编号SiiT-YBBX20150623文档名称接口方案书文档版本号A3文档状态正式稿文档编写完成日期2015-06-23作者深圳市国信合成科技有限公司发布范围xxxx、深圳市国信合成科技有限公司文档变更历史清单文档版本号变更日期修改人备注A12015-06-23深圳市国信合成科技有限公司新建A32015-08-04深圳市国信合成科技有限公司新建3.本次修改变更说明序号变更内容简述A3将接口参数统一调整为小写；增加参数是否为必填项描述目录TOC\o"1-3"\h\z1 需求背景 42 接口需求 43 业务流程 43.1报账单构正常流程 43.2报账单影像修改流程 53.3报账单退单流程 63.4电子凭证流程 74 接口规则描述 85 影像接口描述 85.1影像系统服务接口描述 95.2接口参数如下 95.3接口参数描述 95.4接口返回值 96 影像系统接口参数使用说明 106.1接口列表 106.2接口详细 106.2.1 触发单据扫描流程接口 106.2.2 获得影像调阅地址接口 126.2.3 通知影像系统退单接口(作废接口) 136.2.4 影像系统自动归档接口 146.2.5 发起事后补充流程 157 EForm系统接口参数使用说明 157.1接口列表 157.2接口详细 157.2.1 通知影像状态接口 158 Sun系统接口参数使用说明 168.1接口列表 168.2接口详细 168.2.1 同步凭证中间表 16需求背景深圳市国信合成科技有限公司作为xxxx财务共享影像系统供应商，为配合财务共享影像管理系统项目建设需要合作，需要设计一套通用接口，便于本项目顺利与Eform系统、sun系统集成。接口需求影像系统与其他各系统的需对接如下表所示:序号接口项目接口说明1影像系统接口服务影像系统提供该服务，供两个系统交互时使用，具体使用参考下面详细说明2Eform系统xxxx报账系统3Sun系统xxxx核算系统业务流程说明：下面各个流程描述中，红色的批注为：EForm系统提供的接口（推送接口）；蓝色的为：影像系统提供的接口（设置接口）；（X）中的值为，提交的状态值。||：需要暂停，等待影像反馈的节点；下面的流程说明，也按照这个规则，红色的状态为：EForm系统，蓝色的状态为：影像系统。报账单构正常流程发起人，提交申请后，从Eform系统打印出带有条形码的封面，交给会计初审岗，由会计初审岗的工作人员把封面和单据扫描进影像系统。（此时Eform系统中的影像状态为：等待扫描）,此时业务流程暂停，等待影像系统返回状态；会计初审扫描完单据后，影像系统自动调用“通知状态”接口，通知Eform系统自动触发电子流程进入下一环节（在此之后Eform系统就可以调用“影像调阅接口“接口，查看单据扫描的影像）；最终FSSC复核审批完成后，Eform系统，调用“通知自动归档“接口，通知财务影像系统需要归档对应的单据，财务影像系统自动将对应单据进行归档。报账单影像修改流程影像系统通知EForm系统已经扫描后，EForm系统继续电子流程时，在调阅影像的页面进行重扫操作，财务影像系统自动调用“通知报账单状态“接口，通知EForm系统单据正在重扫，EFrom根据对应的信息，挂起对应单据的电子流程，等待影像系统通知。备注：会计初审岗、FSSC1、FSSC2三个审批环节可发起影像修改指令；其余环节仅供查阅影像。影像系统重扫完成时，会再次调用“通知报账单状态“接口，通知EForm系统单据重扫完成，EForm系统根据信息自动取消电子流程的挂起状态，流程可继续往下流转审批。报账单退单流程EForm系统单据退单（作废）时，需要通知财务影像系统进行同步退单。此时需要调用退单接口，影像系统收到相关信息后，结束财务共享影像系统中的对应单据流程(单号不能再使用)。电子凭证流程SUN系统定时将需要同步的凭证数据写入视图中，财务共享影像系统定期读取sun系统提供视图中获取对应凭证数据后，写入影像系统，凭证后续流程由影像系统进行处理。接口规则描述EForm系统与影像间的接口，采用WebService方式进行数据交互。在交互时，遵循以下规则：根据业务场景，分为同步调用和异步调用两种方式。对于影像退回修改、影像调阅等接口，采用同步调用的方式。影像已扫描、完成回退扫描等接口，采用异步方式。对于调用失败的情况，可由系统进行自动若干次的重试。仍然失败的情况，记录相关日志信息。对于一个单据号的调用，确保调用顺序保持一致，不因异步调用而出现顺序变化。对于接口XML的输入参数和输出参数，所有节点的字母都是小写，由于文档编写可能出现大写，在这里特殊说明。影像接口描述影像系统服务接口描述接口定义为：StringImageInterfaceService(Stringparam)接口参数如下<?xmlversion="1.0"encoding="UTF-8"?><params><safety><clientcode>调用系统编码</clientcode><servicecode>被调用系统编码</servicecode><time>调用时间，格式为：YYYYMMDDHHmmSS,例如：20140712161833</time><ticket>验证串，clientcode+servicecode+time节点的值+双方约定的key生成的MD5值</ticket></safety><serverbody><servername>调用接口标记</servername><services><service><serviceid>每个service的唯一标记</serviceid><…>各个参数节点</…></service><service>…………</service></services></serverbody></params>接口参数描述节点上级节点说明paramsXML根节点safetyparams接口安全验证节点，默认接口是进行白名单(IP)验证，是否进行明文参数验证由具体项目，在影像系统进行配置，需要验证时，time,ticket参数必填，相反则不用clientcodesafety调用系统代码，这里默认为FKservicecodesafety提供服务的系统编码，这里默认为：ImageCentertimesafety明文参数验证时，该节点必输，格式为：YYYYMMDDHHmmSS,例如：20140712165112ticketsafety明文参数验证时，该节点必输，取值为：clientcode+servicecode+time节点的值+“image”的MD5值“image”这个是由双方配置的，可以改变serverbodyparams接口调用参数主体节点servernameserverbody调用的服务标记servertypeserverbody调用的服务类型，0/实时接口，1/定时接口，影像系统可配置，默认取影像系统配置servicesserverbody请求列表节点serviceservername值调用接口每条单独的记录信息，可以一次执行多个单据serviceidservice本个服务的唯一标记各个参数节点service具体的接口中的参数接口返回值<?xmlversion="1.0"encoding="UTF-8"?><root><result>接口处理结果，0/成功，1/失败，这里只表示结果处理是否成功，不表示业务处理是否成功，业务处理是否成功需要解析Item中的内容</result><errormsg>错误信息</errormsg><items><item><serviceid>每个service的唯一标记，入参的值，直接写回到这里</serviceid><result>该serviceid处理结果，0/成功，1/失败</result><success>成功结果</success><errormsg>错误信息</errormsg><…>可以扩充节点</…></item><item>…………</item></items></root>影像系统接口参数使用说明接口列表序号接口项目接口说明1触发单据扫描流程接口Eform系统提交表单时，由EForm系统调用该接口，通知影像系统发起对应的扫描流程。2获得影像调阅地址接口需要查阅影像时，EForm及Sun系统可以通过该链接查看对应单据的影像信息，再IE中打开来查阅对应单据的影像。3获得影像条码生成地址获取对应条码生成条码影像的地址，在IE中打开4通知影像系统自动归档接口其它系统需要自动归档影像系统的归档待办时，需要调用该接口，自动提交影像系统的归档待办工作。5通知影像系统退单(作废)EForm系统退单后，删除，作废，需要通知影像系统退单6发起事后补充流程如果是需要事后补充发票的，需要EForm系统结束流程时，调用该接口通知财务影像系统接口详细触发单据扫描流程接口接口提供方影像系统接口用途EForm需要扫描报账单时，将报账单的基本信息通过该接口推送到影像系统，并等待影像系统扫描接口标记startWorkFlow接口参数名称说明数据类型参数类型必填项barcode影像条码号（索引号）字符串inYEStype单据类型,1报账单字符串inYESbranchcode提单用户所属机构编码字符串inYESPartnerName往来单位名称字符串InNOusername报账人姓名字符串inYESuseraccount操作人账号字符串In（员工代号）YESbilldate报账日期字符串inYESamount金额字符串inYESbillcode表单编号字符串In（单据号）YESbilltype单据类型字符串表单ID(1.1,1.2….)YESbusstype业务类型字符串In（工程款，设备款……）NOremark摘要，描述信息字符串inNO接口入参比如要一次发起单据：TEST2014071200001和TEST2014071200002报账单流程<?xmlversion="1.0"encoding="UTF-8"?><params><safety><clientcode>FK</clientcode><servicecode>ImageCenter</servicecode><time>20140712161833</time><ticket>“FK”+“ImageCenter”+“20140712161833”+“ImageCenterFK”的MD5值，这里就不算了</ticket></safety><serverbody><servername>startWorkFlow</servername><servertype></servertype><services><service><serviceid>1</serviceid><barcode>TEST2014071200001</barcode><type>1</type><branchcode>4400</branchcode><username>zhangsan</username><useraccount>zhangsan</useraccount><billdate>2014-07-12</billdate><amount>123.11</amount><billcode>BXD_201407120023</billcode><billtype>报销单</billtype><busstype>YS</busstype><remark>出差报销</remark></service><service><serviceid>2</serviceid><barcode>TEST2014071200002</barcode><type>1</type><branchcode>4400</branchcode><username>zhangsan</username><useraccount>zhangsan</useraccount><billdate>2014-07-12</billdate><amount>232.11</amount><billcode>BXD_201407120024</billcode><billtype>报销单</billtype><busstype>YS</busstype><remark>出差报销</remark></service></services></serverbody></params>接口出参TEST2014071200001单据触发流程成功，TEST2014071200002单据触发流程失败，返回值如下：<?xmlversion="1.0"encoding="UTF-8"?><root><result>0</result><success></success><errormsg>单据TEST2014071200002触发失败，已经存在且状态为已扫描！</errormsg><items><item><serviceid>1</serviceid><result>0</result><success></success><errormsg></errormsg></item><item><serviceid>2</serviceid><result>1</result><success></success><errormsg>单据TEST2014071200002触发失败，已经存在且状态为已扫描！</errormsg></item></items></root>获得影像调阅地址接口接口提供方影像系统接口用途扫描后，其他系统可以根据这个接口调阅对应单据的影像信息接口标记createImagePath接口参数名称说明数据类型参数类型必填项barcode影像条码号StringInYESevaluation是否可以评价，1可以评价，其他为不可以评价StringinYEStype调阅的单据类型，1报账单StringInNOcandownPrint是否可以下载和打印影像，1可以，0或者其他不可以StringInYEScommentType批注操作标识：0无权看见批注，默认1可以看见批注2可看见且能编辑StringInYESimageop操作限制：1/只能补充，2/只能删除，3/不限制StringInYESuseraccount查阅用户帐号StringInYESaccountdate记账日期StringInNOshowother是否显示关联影像,0不显示，1显示，默认0StringInYES参数使用说明：1.参数组合使用：在会计初审环节、FSSC1、FSSC2审批环节时Evaluation=1、CanDownPrint=1、commentType=1、imageop=3；2.参数组合使用：其余审批待办环节，Evaluation=0、CanDownPrint=0、commentType=0、imageop=0；3.accountdate、showother默认不用传输接口入参比如要查看：TEST2014071200001单据的影像<?xmlversion="1.0"encoding="UTF-8"?><params><safety><clientcode>FK</clientcode><servicecode>ImageCenter</servicecode><time>20140712161833</time><ticket>MD5值，这里就不算了</ticket></safety><serverbody><servername>createImagePath</servername><servertype></servertype><services><service><serviceid>1</serviceid><barcode>TEST2014071200001</barcode><type>1</type><evaluation>1</evaluation><CanDownPrint>1</CanDownPrint><commentType>0</commentType><imageop>0</imageop><userid>zhangsan</userid><accountdate>2014-10-12</accountdate><showother>1</showother></service></services></serverbody></params>接口出参<?xmlversion="1.0"encoding="UTF-8"?><root><result>0</result><success></success><errormsg></errormsg><items><item><serviceid>1</serviceid><result>0</result><success>/showImage.do?barcode=TEST2014071200001</success><errormsg></errormsg></item></items></root>通知影像系统退单接口(作废接口)接口提供方影像系统接口用途Eform系统，根据单据作废，删除等操作，如果单据已经在影像系统中存在，那么就要调用该接口接口通知影像系统退单接口标记rejectBill接口参数名称说明数据类型参数类型必填项barcode影像条码号字符串inYESbilltype单据类型，1/报账单StringinNOuseraccount退单人帐号字符串inYESusername退单人姓名字符串inYESphone退单人电话字符串inNOremark退单描述字符串inNO使用说明影像系统自动归档接口接口提供方影像系统接口用途Eform系统走完所有审批流程时，确定影像无误且不能再修改时，调用该接口锁定影像数据，锁定后只能查阅接口标记lockedBillcode接口参数名称说明数据类型参数类型必填项barcode影像条码号字符串inYESbilltype单据类型，1/报账单NOBustype业务类型，暂定为定值:FK字符串inNOoptype操作类型，1提交到待归档，2自动归档，默认是自动归档YESvoucher凭证信息year凭证年度NObranch凭证帐套date制证日期NO注：barcode，bustype，optype是必填参数，其它是可选参数。Param参数有数据时，解析更新对应字段信息。??对应条码如果不存在，或不在对应环节返回对应的信息。本项目optype传参数2使用说明参考7.2.1发起事后补充流程接口提供方影像系统接口用途有些单据在结束流程后，还需要后期补充一些发票信息，但是该单据一般有滞后性，不是很及时可以获取到，所以需要先报账后，后期再补扫进来，要在补录时，就需要这个接口来完成。接口标记startImagePlusFlow接口参数名称说明数据类型参数类型必填项barcode影像条码号字符串inYESbilltype单据类型，1/报账单字符串InNOu