XX集团有限公司XX财务平台与相关信息系统接口改造需求说明书.docx
XX集团有限公司XX财务平台与相关信息系统接口改造需求说明书1 .概述为了配合计划财务部推进财务报销管理系统、应收管理系统、应付管理系统项目建设,规范合同、客商等信息数据,实现与财务系统对接与数据交互,为对台、集团下属各前端合同管理系统进行规范化、系统化管理,计划对现有OA协同办公平台、集团合同管理系统、影视剧管理系统、XX合同管理系统四个信息化进行相应改造。为了实现财务应收、应付自动化、一体化管理,需要建立台、集团统一客商库,并将各合同管理系统中的合同归档信息(主要包括合同名称、经办单位、对方单位、收付款类型、有效期等基础信息,合同正本扫描件、会签单等等)实时同步到财务应收、应付管理系统。2 .各关联平台职责前端合同管理系统- 合同起草、审批、盖章等全流程合同在线监管- 将审批流程已完成,进入归档阶段的字段推送给财务中台- 本次项目涉及OA协同办公平台、集团合同管理系统、影视剧管理系统、XX合同管理系统四个信息化系统,四个信息化系统详细情况如下表所示。序号系统名称使用范围1集团合同管理系统集团职能部门、事业部2OA协同办公平台XX卫视中心,XX广播中心,融媒体中心,X3影视剧管理系统X影视剧中心4XX合同管理系统XXXX传媒技术有限公司财务中台- 接收来自财务中台的收付款内容- 回传收付款结果到财务中台- 主要包括财务应收管理系统和财务应付管理系统财务中台一客商模块- 推送客商信息到各个前端合同管理系统以供使用- 历史签约情况、合同执行各环节记录况查看- 风险客商预警3.需求详细说明本次改造重点是各信息化系统统一客商库,将合同前端系统的合同归档相关信息实时同步到财务中台系统,便于财务后续应收与应付的有效管理。合同前端系统与财务中台之间数据交互详细逻辑如下图所示。业务流程图合同前排系统财务中台财务中台单点登录平台客商档案组织架构用户信息客商档案归档系统定时抓取归档系统定时抓取客商档案组织柒构用户信息财奂推送合同修订合同面单手0A合同终止审影/过归档导入接口一H合同归档信息接口合同档案报销单L雷自闻R谟乐线中 !幄崖口冏号状总变更接口 ÷合同详情显示收付款接口收付款单调用1)在前端合同管理系统中完成合同新建、审批、修改变更、附件上传等一系列动作。当合同管理系统审批结束,进入归档节点,推送需归档字段到财务中台,合同状态为“生效”。2)在前端合同创建补充合同需要具有合同号,需设置与主合同的关联关系并推送财务中台。3)补充合同创建时需通知财务中台将主合同状态变为“变更中”。补充合同归档后,再次通知财务中台将主合同状态变更为“生效”。4)前端合同管理系统去除客商创建功能,创建新合同时先从本地客商库中选择,如该客商需要新建,则从财务中台客商模块中创建新客商,并从客商模块中将相关客商信息推送到对应的前端合同系统方才可以被选择。5)如客商被用户赋予了警示状态则各系统均可看到相关状态,但该客商仍然能够被选择进行合同申请。6)如客商被加入了黑名单,需推送相关状态到前端合同系统的具体分部处,该客商在前端合同系统中,该分部的用户可见该客商的“黑名单”状态,并不可选择该客商进行合同申请。7)当前端合同进入财务中台,财务中台根据相关信息完成收付款操作后将相关信息在财务中台进行记录。8)财务中台进行收付款操作时,可以实时调取合同详情及附件进行查看。9)以后如因业务需求,需增加各对接接口的推送字段,可以通过配置完成字段的添加,不需要对接口进行另外的开发。10) 各对接系统均需要对数据传输进行日志记录。记录相关数据的推送/接收时间,具体推送/接收接口,推送/接收源或目标,推送/接收内容,是否推送/接收成功等信息,如数据推送/接收失败需记录具体的报错信息,以方便问题定位排查解决。4.相关接口需求说明4.1 返回值注意:后续所有接口,均按照以下格式返同:("code”:0,“message":”,/描述"result":,/结果"success":true,执行结果成功true,还是失败false;"timestamp":0/时间戳4.2 获取token令牌接口地址:/smg-bootcontractapigetToken请求方式:GET接口描述:用于后续接口参数herder头文件信息X-ACCeSS-TOken参数值有效期:60分钟(可调整)请求参数:参数名称参数说明请求类型是否必须数据类型username用户帐号querytruestring响应参数:参数名称参数说明类型code返回代码integer(int32)message返回处理消息stringresult返回数据对象objectsuccess成功标志booleantimestamp时间戳integer(inl64)响应示例:(,success"rtruez“message":"操作成功!",code"Oz,result,eyJOeXAiOKVlQiLCJhbGciOiJIUzllNiJ9.eyJleHAiOjE10TkONzlMTEslnVzZXJuYWllljoiMSJ93GraSZ42a2BVkDur-ZKOd-TlyKYRVOj.x9oeCpOTg"z,timestamp"zl599473711395)4.3 合同新增/更新接口接口地址:smg-boot/contract/api/synContract调用方:前端合同系统被调用方:财务中台请求方式:post同步时机:实时接M描述:合同归档对外接口请求参数:参数名称参数说明请求类型是否必须数据类型ContraclPage合同归档表bodytruecontract对象X-Access-TokenaiKeyheadertruect_contractPage对象参数名称参数说明请求类型必输数据类型备注SourceSys外部系统来源bodytruestringexterSysId外部单据IDb(lytruestringadvert是否含有广告元素bodytruestring是/否afterawerMemo事后合同说明bodyfalsestringafterwardsCt是否为事后合同bodytrueString是/否amountMemo金额备注bodyfalsestringauthorization授权方向bodyfalsestring授权方、被授权方、各方分配beginDale合同生效日期bodyfalsestringyyyy-mm-ddContractBCode关联合同编号(如果是补充协议,必输,这里是所关联的外部单据exterSysId)bodystring当为补充协议是必输CoppyrightValid版权期限bodyfalsestringCopyrightProp版权性质bodyfalsestring独家/非独家CtCode合同号bodytruestringCtCodeYw业务合同号bodyfalsestringCtDescibe合同背景及主要内容bodytruestringCtName合同名称bodytruestringCtType是否补充协议bodytruestring是/否CtValidity合同有效期bodytruestringXXXX年XX月XX日一XXXX年XX月XX日;合同签订后多少天生效CustomerBan对方账号开户行bodyfalsestringCustomerBankno对方收款账号bodyfalsestringfwdemo法务备注bodytruestringhandlingCo)经办单位编码bodytruestring与HR架构一致HandlingCorpName经办单位名称bodyfalsestringhandlingDept经办部门编码bodytruestring与HR架构一致handlingDeptName经办部门名称bodyfalsestringhandlingUser经办人工号bodytruestring与HR系统一致handlingUserName经办人姓名b(lyfalsestringkeyWord关键词bodyfalsestringIegerUser法务人员工号bodyfalsestring与HR系统一致IegerUserName法务人员姓名bodyfalsestringmemo备注bodyfalsestringnyear年度bodytruestring合同前端系统中创建流程日期的年度OriginalAmount合同原币金额bodytruenumberOriginalCurrency合同原币币种bodytruestringCNY/USD/JPY/EUR/GBP/HKD/AUD/KRWpartnerld对方单位编码bodytruestring参照NCC客商档案PartnerName对方单位名称bodytruestringpayType收付款类型bodytruestring收付款类型,传名称收款、不固定金额收款、付款、不固定金额付款、不涉及费用priority紧急程度bodyfalsestring特急、紧急、一般prqjectld项目编号bodyfalsestring参照NCCprojectName项目名称bodyfalsestringIechnicalServic是否外部技术服务bodytruestring是/否IemplelCtFIag是否为格式合同bodytruestring是/否vatFlag是/否增值税专用发票bodytruestring是/否weBank我方账号开户行b(lyfalsestringweBankno我方收款账号bodyfalsestringWeCorpId我方单位编号bodytruestring参照NCC内部客商WeCorpName我方单位名称bodyfalsestringincomeType收入类型bodyfalsestring选项:直客、整合营销、贴片、4A1,接口传名称placeFiles归档附件bodyFalsestringContractFiles合同相关附件bodyfalsestringContractPlannpayList计划付款bodytruearrayContractPsnList合同审批人bodytruearrayContractPsnUst对象参数名称参数说明请求类型是否必须数据类型no序号b(lytrueinteger(int32)userid用户IDbodyfalsestringusercode工号bodytruestringusername用户名称bodytruestringContractPIannpayUst对象参数名称参数说明请求类型是否必须数据类型no序号bodytrueinteger(int32)PayDelailMemo备注bodyfalsestringpayAmount金额bodytruestringayTerm收付款信息bodyfalsestring请求示例exterSysld":"127894356233456,"sourceSys':"001"z"advert":"","afterawerMemo":","afterwardsCt":,""amountMemo":"',z"authorization":,"beginDate":',"z"contractBCode":,f"CoppyrightVaIid":Oz"CopyrightProp":","ctCode":",z"ctCodeYw":"CtDescibe":"","ctName":""z,ctSource":""z,ctType":“否","CtVaIidity":"","customerBan":,t"CustomerBankno":",',"endDate":",z"fwdemo":""z"handlingCorp":"""handlingCorpName":,",z"handlingDept":m,f"handlingDeptName":""z"handlinguser":""z"handlingUserName":,',f"keyword":"IegerUser":"","IegerUserName":""z"memo":"","nyear":""z"OriginalAmount":O,"originalcurrency":"","partnerld":"partnerName":,","payType":""z"priority":“特急”,"projectld":,",projectName":""z',technicalServic":",z"templetCtFlag":,z"templetFileMemo":,",z"vatFlag":""z"weBank":""”,"weBankno":'""z"weCorpld":"""z"weCorpName":'",z"ContractPIannpayUst":("no":O,"billno":""z"payAmount":,"z,payTerm":',","PayDetaiIMemo":"")1."ContractPsnList":("no":Oz"userid":'""z"usercode":,ll>>username:)响应参数:参数名称参数说明类型code返回代码integer(int32)message返回处理消息stringresult返回数据对象objectsuccess成功标志booleantimestamp时间戳integer(int64)响应示例:("code":Ot"message":'",z"result":f"success":true,"timestamp":O4.4 合同附件上传接口接口地址:smg-bootContraCtapiupload调用方:前端合同系统被调用方:财务中台请求方式:post同步时机:实时接口描述:合同归档对外接口请求参数:参数名称参数说明请求类型是否必须数据类型exterSysId外部系统单据IDquerytruestringsourceSys外部系统来源编码querytruestring001:致远002:泛微fileType附件类型querytruestring2:归档附件4:其他相关附件files多个文件fbrmDatatrueArray<file>X-Access-TokenapiKeyheadertrue响应参数:参数名称参数说明类型code返回代码integer(int32)message返回处理消息stringresult返回数据对象objectsuccess成功标志booleantimestamp时间戳integer(int64)响应示例:"code":0,"message":""z"result":,"success":true,"timestamp":04.5 合同更新状态接口接口地址:smg-bootContraCtapiuPdateContractStatus调用方:前端合同系统被调用方:财务中台请求方式:post同步时机:实时接口描述:合同归档对外接口请求参数:参数名称参数说明请求类型是否必须数据类型exterSysId外部系统单据IDquerytruestringsourceSys外部系统来源编码querytruestring001:致远002:泛微CtStatus合同状态querytruestring1:生效2:变更中3:终止X-Access-TokenapiKeyheadertrue响应参数:参数名称参数说明类型code返回代码integer(int32)message返回处理消息stringresult返回数据对象objectsuccess成功标志booleantimestamp时间戳integer(int64)响应示例:("code":0,"message":""z"result":f"success":true,"timestamp":04.6 客商接口接口概述:NCC客商接口推送数据流向:NCC客商平台->X(前端合同系统)接口方式:HTTP接口频率:实时增量推送接口地址:,httpIP:端口/service/ICUSmerServlet输入参数:json回执参数:json输入表名字段说明字段名数据类型是否必输备注servercode调用系统编码string是归档系统:01,泛微系统:02、OA系统:03apicode接口编码string是01(默认)datasCustcode客商编码String是varchar(40)客商编码Custname客商名称多语文本是varchar(200)客商名称shortname客商简称String是varchar(200)客商简称CreditJd社会统一信用代码String是varchar(20)blacklist_flag是否警示String是varchar(101)女,警示标识pk_ncc客商档案PkUFID是char(20)NCC客商基本信息后台主键,Pk值(唯一码)supprop客商类型是smallintO=外部单位,I=内部单位pk_financeorg对应业务单元主键UFID是varchar(20)内部客商对应的公司(我方单位)dr删除标记integer是smalint客商删除标记:0为正常1为删除banks(隐藏)baNk_no客商银行账号String否varchar(40)银行账号bank_name客商银行户名String否varchar(200)银行账户户名bank_pk客商银行pkUFID否char(20)银行账户后台主键(唯一码)bank_deposit_code开户行编码String否varchar(40)开户银行编号bank_deposit_name开户行名称多语文本否varchar(200)开户银行名称bank_deposit_pk开户行PkUFID否char(20)开户银行后台主键(唯一码)fisfi_org_cOde所属财务组织代码多语文本是varchar(200)对方单位的所属财务组织(区分客商被分配到了哪个单位)fi_org_name所属财务组织名称String是varchar(40)对方单位的所属财务组织(区分客商被分配到了哪个单位)fi_org_pk财务组织PkUFID是char(20)对方单位的所属财务组织(区分客商被分配到了哪个单位)payfreezeflag付款冻结UFBoolean是char(l)冻结后控制不允许再签订合同输出表名字段说明字段名数据类型是否必输长度备注状态resultstring是O-成功I-杳询失败系统编码codestring是调用系统编码回执信息messagestring否操作信息查询结果明细datasjson是datas对方系统数据IDSySJdstring是参考示例:("result":“。,,code",01"z,datas,':("sys_id":"OOOOl"I"message":""4.7 合同调阅页面接口地址:usercontractlnfo请求方式:GET接口描述:合同归档对外接口请求参数:参数名称参数说明请求类型是否必须数据类型tokenapiKeyquerytruectcode合同号querytruestring相关错误提示:1、未找到对应数据(合同归档系统未找到此合同)2、很抱歉,登录已过期,请重新登录(token已失效,请重新调用获取token令牌接口)