企业联机接口报文规范货物贸易外汇监测系统V10.doc

《企业联机接口报文规范货物贸易外汇监测系统V10.doc》由会员分享，可在线阅读，更多相关《企业联机接口报文规范货物贸易外汇监测系统V10.doc（104页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、【精品文档】如有侵权，请联系网站删除，仅供学习与交流企业联机接口报文规范货物贸易外汇监测系统V10.精品文档.货物贸易外汇监测系统企业联机接口报文规范版本号：V1.0国家外汇管理局2015年2月变更履历修改编号版本修改内容修改人修改日期目 录1 范围42 术语和接口说明43 要求43.1 数据类型定义43.2 数据处理规则53.3 报文格式校验54 接口格式概述64.1 报文接口格式结构65 报文格式说明75.1 实时业务类76 集团企业数据权限说明127 报文定义127.1 基础业务数据查询147.2 预收/预付报告217.3 延收/延付报告277.4 转口贸易收支时间差报告347.5 多收

2、汇/多付汇差额报告397.6 多进口/多出口差额报告437.7 其他特殊交易报告467.8 出口收入存放境外报告517.9 企业信息查询657.10 业务指标情况查询服务667.11 业务汇总数据查询717.12 现场核查727.13 信息交互747.14 登记表业务778 报文样例839 Schema校验文件8310 数据字典8310.1 收汇性质8310.2 付汇性质8410.3 结算方式8410.4 涉外收支交易代码8410.5 贸易方式8410.6 登记表类别8710.7 登记表状态8710.8 差额原因代码8711 错误编码与错误名称对应表881 范围货物贸易外汇监测系统企业联机接口

3、报文规范，规定了国家外汇管理局（以下简称“外汇局”）货物贸易外汇监测系统与企业自身业务系统进行联机实时业务交互时，应采用的报文格式和规范。2 术语和接口说明l 标识符：唯一标识报文中一个数据项或者节点项的代码。l 报文：用于外汇局与联网机构间交换信息的载体。l 报文头：报文通讯使用的基本信息。l XML节点TAG：某一段数据域的标识，比如报文头、用户信息等，用于组织报文中节点项的代码。l 节点代码：为了方便管理，对于接入的机构，由外汇局进行编码并分配给接入单位使用。对于企业，节点代码采用“组织机构代码证”的代码，共9位。3 要求3.1 数据类型定义3.1.1 字符集x-字符集由以下87个字符组

4、成：a b c d e f g h i j k l m n o p q r s t u v w x y zA B C D E F G H I J K L M N O P Q R S T U V W X Y Z0 1 2 3 4 5 6 7 8 9 (cr) (lf) (space)对于使用TCP/IP协议的系统，x-字符集的编码（字符的二进制编码）适用于ISO-2022（ASCII）3.1.2 符号约定符号说明String表示由x-字符集组成的字符串，如：PbcGkjCfccNString表示由数字0-9组成的字符串，如：000045GBString表示由GBK字符集组成的字符串，报文规范中的

5、长度定义以字节为单位，如：商业Currency表示金额，符号位可选，整数部分最长15位，小数部分固定两位，不能包含逗号等分隔符，如：8979.05Integer表示整数，符号位可选，数值部分最长8位，如：88888Decimal表示实数，如：655785.5676Long表示日期。日期是毫秒数，毫秒数是根据1970-1-1为参照值，由参数日期减去参照值将结果转换为毫秒数得来的如：1333248494648Date表示日期，格式为 yyyy-mm-dd（年月日）。如：2005-06-11Time表示时间，格式为 HH:MM:SS（时分秒）。如：11:28:21DateTime表示日期时间，格式为

6、 yyyy-mm-dd HH:MM:SS（年月日时分秒）。如：2005-06-11 11:27:39 HexBinary表示按十六进制编码,的二进制数据，如：4F59B25ABoolean表示布尔值(true或false)，如：true3.2 数据处理规则(1) 对于每个字段所填内容，在后面的章节中针对不同报文将具体说明。(2) 当“长度”是n时表示此域出现时，长度固定为n个字符；当“长度”是1,n时表示此域出现时，其最小长度为1个字符，其最大长度为n个字符。(3) 当“强制/可选”是M时，表示此要素为强制项，必须出现；当“强制/可选”是O时，表示此要素为可选项，根据业务要求填制，不必须出现，

7、但一旦出现，则其中内容必须出现，不可为空。3.3 报文格式校验本规范对XML格式的请求报文提供了Schema校验文件，请求方系统在发起请求前需要根据Schema文件对请求报文进行格式校验。4 接口格式概述国家外汇管理局业务信息系统与企业接入机构通过报文进行联机交互。4.1 报文接口格式结构4.1.1 报文结构4.1.1.1 参考原则4.1.1.1.1 规范原则所有数据报文使用XML进行描述（有特殊说明的部分以说明为准）。4.1.1.1.2 高效性原则由于国家外汇管理局业务信息系统对报文进行实时处理，因此将追求效率作为首要目标。4.1.1.1.3 易读性原则在保证报文交换和处理高效的前提下，尽可

8、能提高报文的易读性，以利于系统测试和联调。4.1.1.2 结构说明报文结构如下图所示：说明：总体上，报文全部内容封装在一个XML报文中，报文分为三大部分：报文头、报文体及报文尾。n 报文头部分报文头部分用于标识XML报文的基本属性，包括报文版本号、机构类型、发起节点代码、接收节点代码、发送方系统标识、接收方系统标识、用户信息、发送时间等等信息。n 报文体部分报文体部分是业务信息，包括业务参数、数据集合两部分。n 报文尾部分数字签名部分用于存放报文的数字签名信息，用于交易参与方的身份认证。算法对报文开始（即从行开始）至之间的全部内容（不包括报文尾信息）进行签名，并以XML注释的形式存储于原XML

9、报文的尾部。校验和通常在通信过程中保证内容的完整性和准确性。发送端通过对报文内容运用特定算法计算得出校验和，接收端接收到报文后也对报文进行同样的计算，如果结果一致则代表内容没被改变。注：标准XML报文首位字符不允许出现空格等字符，应以?xml version 开始。具体格式示例如下：报文头内容报文体内容报文尾n 组件组件是一个逻辑概念，它用来表示一组彼此之间有一定关系的消息域的组合。这些组件在协议中都赋以相应的名称，用来更好的理解消息结构以及所应用的场景。在实际消息传送过程中，这些组件名称并不会作为信息消息中出现，可以这么说，组件的出现是起到更好让人能够理解消息结构的作用。n 重复组域可以在重

10、复组里多次重复，用以传输数组同类的数据。在协议中，重复组也同样是一个逻辑概念，它用来表示一组彼此之间有一定关系的消息域的组合能够连续反复地在消息中出现。5 报文格式说明5.1 实时业务类此类报文主要包含请求报文和回执报文。5.1.1 请求报文格式5.1.1.1 报文格式说明：请求报文由报文头、报文体、报文尾组成。报文头包括报文通讯使用的基本信息和控制信息；报文体包括公共参数和业务数据集合，而业务数据信息又包括分页信息、业务参数信息和业务数据信息；报文尾是数字签名和校验和信息。5.1.1.2 数据项5.1.1.2.1 报文头XML节点TAG：MSG-HEAD标识符字段名称类型长度备注强制/可选V

11、ER报文版本号NString1,4当前为2014MCOMMON_ORG_TYPE机构类型NString1,41：外汇局、2：银行、3：企业。MSRC 发起节点代码NString4或9企业：组织机构代码 MDES接收节点代码NString6外汇局：默认100000MSRCAPP发送端应用代码String1,100发送端应用名称，由报文的发起方自行控制ODESAPP接收端应用代码String1,100接收端应用名称，例如货物贸易外汇监测系统为 TMISMSENDTIME发送时间DateTime 报文发送时间MCOMMON_ORG_CODE机构代码String1,40企业：组织机构代码 MCOMMO

12、N_USER_CODE用户代码String1,40用户代码MPASSWORD密码String1,50密码（明文密码需经MD5（32位，小写）加密）MSERVICEPATH访问服务信息String5,100服务名称+“.”+方法名称MMSGNO报文参考号String1,33企业：组织机构代码+年月日+8位唯一代码M5.1.1.2.2 报文体公共参数信息XML节点TAG：MSG-BODY-PARAMETERS 说明：此节点是业务公共参数位置,主要用于非分页查询和写操作时传参，参数的详细定义见本文档报文的定义部分。数据集信息XML节点TAG ：MSG-BODY-DATASTORES-DS1标识符数据

13、项名称类型长度数据项描述强制/可选PAGESIZE每页条数NString1,10最大不能超过1000条MPAGENUMBER页码NString1,10当前是多少页M说明：对于分页查询，以上内容是必输，如果不输入PAGESIZE值默认是1000；对于非分页查询和写操作，以上内容无需存在。XML节点TAG ：MSG-BODY-DATASTORES-DS-PARAMETERS 说明：PARAMETERS下是业务参数，此节点下的参数为非必输参数，此节点下的参数为非必输参数，此节点为分页查询和写操作入参位置。XML节点TAG ：MSG-BODY-DATASTORES-DS-ROWSET标识符数据项名称类

14、型长度数据项描述强制/可选ROW数据集GBString数据集，可循环出现O说明：ROW可以重复出现，详细定义见本文档对报文的定义部分。5.1.1.2.3 报文尾XML节点TAG ：MSG- TAIL标识符数据项名称类型长度数据项描述强制/可选SIGNATURE数字签名String0,300暂不使用OCHECKSUM预留字段String0,300暂不使用O5.1.2 回执报文格式 5.1.2.1 报文格式说明：由一个报文头、一个回执信息、报文尾构成。5.1.2.2 数据项5.1.2.2.1 报文头XML节点TAG：MSG-HEAD标识符字段名称类型长度备注强制/可选VER报文版本号NString

15、1,4当前为2014MSRC 发起节点代码NString6外汇局：默认100000 MDES接收节点代码NString4或9企业：组织机构代码MSRCAPP发送端应用代码String1,100外汇局端应用名称，例如货物贸易外汇监测系统为 TMISMDESAPP接收端应用代码String1,100接收端应用名称，对应请求报文中的发送端应用代码OSENDTIME发送时间DateTime 报文发送时间MMSGNO报文参考号String1,33对应请求报文中的报文参考号MCODE状态码NString1,6处理成功是00000，如果错误返回错误码MDETAIL错误详细信息GBString1,200错误详

16、细信息O5.1.2.2.2 报文体 XML节点TAG ：MSG-BODY-DATASTORES-DS1标识符数据项名称类型长度数据项描述强制/可选PAGESIZE每页条数NString1,10最大值为1000MPAGENUMBER页码NString1,10当前是多少页MRECORDCOUNT记录总条数NString1,10记录总条数M说明：DS为重复组，可以重复出现，但有多个时要有编号，即DS+i,i从1开始，如,。对于分页查询以上三项为必输项，对于非分页查询以上三项无需存在。XML节点TAG ：MSG-BODY-DATASTORES-DS-PARAMETERS 说明：PARAMETERS下是

17、业务参数，此节点下的参数为非必输参数，用于分页查询和写操作时存放入参，详细定义见本文档对报文的定义部分。XML节点TAG ：MSG-BODY-DATASTORES-DS-ROWSET标识符数据项名称类型长度数据项描述强制/可选ROW数据集String数据集，可循环出现O说明：ROW可以重复出现，详细定义见本文档对报文的定义部分。5.1.2.2.3 报文尾XML节点TAG ：MSG- TAIL标识符数据项名称类型长度数据项描述强制/可选SIGNATURE数字签名String0,300暂不使用OCHECKSUM预留字段String0,300暂不使用O6 集团企业数据权限说明对于集团型企业，主办企业

18、可以查询成员企业的业务数据，但是企业报告等交易业务仍需要以成员企业的身份进行报告。当主办企业调用查询类服务查询成员企业的业务数据时，需要在报文体中填写对应企业的企业代码。集团企业的关联关系需要由主办企业所在外汇局报总局通过“集团企业管理”模块进行登记。7 货物贸易外汇监测系统报文定义货物贸易外汇监测系统通过联机接口向企业提供了14个业务领域、共计53个webservice服务，具体列表如下：业务领域服务服务名称基础业务数据查询SafeBaseDataServicedoQueryBaseDataRcv报告对应收汇数据查询doQueryBaseDataPay报告对应付汇数据查询doQueryBas

19、eDataExp报告对应出口数据查询doQueryBaseDataImp报告对应进口数据查询预收/预付报告SafeGoodsServicedoAddGoodsAdvancePrepaidReport 预收/预付报告新增doExecuteFirstGoodsAdvancePrepaid 预收/预付报告查询doExecuteFirstGoodsAdvancePrepaidReport预收/预付报告明细查询doRemoveGoodsAdvancePrepaidReportByID 预收/预付报告删除doModifyCreditReport 预收/预付报告修改和调整延收/延付报告SafeFEServi

20、cedoAddGoodsDelayPayingReport延收/延付报告新增doExecuteGoodsDelayPaying延收/延付报告查询doExecuteGoodsDelayPayingReport延收/延付报告明细查询doRemoveGoodsDelayPayingByID延收/延付报告删除doModifyCreditReport延收/延付报告修改和调整转口贸易收支时间差报告SafeReExportTradeServicedoReExportTradeReportAdd 转口贸易收支时间差报告新增doReExportTradeReportQuery转口贸易收支时间差报告查询doReE

21、xportTradeReportDetailQuery转口贸易收支时间差报告明细查询doReExportTradeReportDel转口贸易收支时间差报告删除doReExportTradeReportModify 转口贸易收支时间差报告修改和调整多收汇/多付汇差额报告SafeFEDiffServicedoAdPayRecieveReport多收汇/多付汇差额报告新增doExcMoreMorePaymentCollectionReport多收汇/多付汇差额报告查询doModPayRecieveReport多收汇/多付汇差额报告修改doRemPayRecieveReport多收汇/多付汇差额报告删

22、除多进口/多出口差额报告SafeGoodsDiffServicedoAdImportExportReport多进口/多出口差额报告新增doExcPayRecieveReport多进口/多出口差额报告查询doModImportExportReport多进口/多出口差额报告修改doRemImportExportReport多进口/多出口差额报告删除其他特殊交易报告SafeSpecTranServicedoAdSpecialReport其他特殊交易报告新增doExcSpeciaExporFEDifftReport其他特殊性交易收付汇报告查询服务doExcSpeciaExporDifftReport其

23、他特殊性交易进出口报告查询服务doModSpeciaExportReport其他特殊交易报告修改doRemSpecialExportReport其他特殊交易报告删除企业信息查询SafeEnterpriseInfoServicedoQueryCorpInfo企业信息查询业务指标情况查询服务SafeBussTargetServicedoQueryIndexInfo业务指标情况查询业务汇总业务查询SafeDataServicedoQueryBasicDataInfo基础业务数据查询现场核查SafeSiteCheckServicedoModNoticeMsg现场核查信息反馈doQueryNoticeM

24、sg现场核查信息查询信息交互BaseInfoServicedoAddBankSysbbsmsg新建留言doQueryBankSysbbsmsg留言查询doQuerySafeSysboardmsg公告信息查询登记表业务SafeRegistTableServicedoQueryRegTradeMark登记表查询doGetRegistTableMark登记表签注信息查询出口收入存放境外报告SafeForiegnAccountServicedoQueryOutSideAccountReport境外收支报告查询doQueryOutSideAccountRegistQuery境外开户查询doAccount

25、NumberQuery境外开户账号查询doAdAccount境外开户新增doModAccount境外开户修改doRemAccount境外开户删除doAdOutSideReport境外收支报告新增doModOutSideReport境外收支报告修改doRemOutSideReport境外收支报告删除7.1 基础业务数据查询7.1.1 报告对应收汇数据查询名称报告对应收汇数据查询描述该服务为接入客户端提供可做报告对应收汇数据查询服务功能，领域层接口为：SafeBaseDataService，方法名称为：doQueryBaseDataRcv7.1.1.1 请求报文XML节点TAG ：MSG-BODY

26、-DATASTORES-DS1-PARAMETERS 标识符字段名称类型长度强制/可选备注CORPID 企业代码 String9MRPTNO 申报单号String22OPAYTYPE收汇性质是否为预收货款String1O空代表全部，“1”代表是，“0”代表否TXSTARTDATE收汇起始日期DateOTXENDDATE收汇截止日期DateOUDSTARTDATE更新起始日期DateOUDENDDATE更新截止日期DateOCONTRACTNO 合同号String30O模糊查询业务规则：1、 收汇起始日期和收汇截止日期必须同时输入或同时为空。2、 更新起始日期和更新截止日期必须同时输入或同时为空

27、。3、 申报单号、收汇起始日期和收汇截止日期、更新起始日期和更新截止日期三者不可同时为空。4、 输入申报单号，其他查询条件失效。7.1.1.2 回执报文XML节点TAG ：MSG-BODY-DATASTORES-DS1-ROWSET-ROW 标识符字段名称类型长度强制/可选备注RPTNO 申报单号String22TXCCY 收汇币种String3TXAMT 收汇金额DecimalBIZDATE 收汇日期DateTXREM合同号（交易附言1）String22CORPID 企业代码String9CORPNAME 企业名称GBString256CUSTNAME 付汇人姓名GBString256COU

28、NTRYCODE 付汇人国别StringPAYTYPE 收汇性质String1A-预收货款R-退款O-其它PAYMETHOD 结算方式String22L信用证G保函C托收T电汇D票汇M信汇O其他TXCODE1交易编码1String6TXAMT1 相应金额1DecimalTXCODE2交易编码2String6TXAMT1 相应金额2 DecimalCONTRACTNO合同号String22UPDATEDATE更新日期DateTime7.1.2 报告对应付汇数据查询名称报告对应付汇数据查询描述该服务为接入客户端提供可做报告对应付汇数据查询服务功能，领域层接口为：SafeBaseDataServic

29、e，方法名称为：doQueryBaseDataPay7.1.2.1 请求报文XML节点TAG ：MSG-BODY-DATASTORES-DS1-PARAMETERS 标识符字段名称类型长度强制/可选备注CORPID 企业代码 String9MRPTNO 申报单号String22OPAYTYPE付汇性质是否为预付货款String1O空代表全部，“1”代表是，“0”代表否TXSTARTDATE付汇起始日期DateOTXENDDATE付汇截止日期DateOUDSTARTDATE更新起始日期DateOUDENDDATE更新截止日期DateOCONTRACTNO 合同号String30O模糊查询业务规则

30、：1、 付汇起始日期和付汇截止日期必须同时输入或同时为空。2、 更新起始日期和更新截止日期必须同时输入或同时为空。3、 申报单号、付汇起始日期和付汇截止日期、更新起始日期和更新截止日期三者不可同时为空。4、 输入申报单号，其他查询条件失效。7.1.2.2 回执报文XML节点TAG ：MSG-BODY-DATASTORES-DS1-ROWSET-ROW 标识符字段名称类型长度强制/可选备注RPTNO 申报单号String22TXCCY 付汇币种String3TXAMT 付汇金额DecimalBIZDATE 付汇日期DateCONTRACTNO 合同号String22CORPID 企业代码Stri

31、ng9CORPNAME 企业名称GBString256CUSTNAME 收汇人名称GBString256COUNTRYCODE 收汇人国别String3PAYTYPE 付汇性质StringA-预付货款P-货到付款R-退款O-其他PAYMETHOD 结算方式String22L信用证G保函C托收T电汇D票汇M信汇O其他TXCODE1交易编码1String6TXAMT1 相应金额1DecimalTXCODE2交易编码2String6TXAMT2 相应金额2DecimalUSDAMT 付汇金额折美元DecimalUPDATEDATE更新日期DateTime7.1.3 报告对应出口数据查询名称报告对应出

32、口数据查询描述该服务为接入客户端提供可做报告对应出口数据查询服务功能，领域层接口为：SafeBaseDataService，方法名称为：doQueryBaseDataExp7.1.3.1 请求报文XML节点TAG ：MSG-BODY-DATASTORES-DS1-PARAMETERS 标识符字段名称类型长度强制/可选备注CORPID 企业代码 String9MENTRYID报关单号String18O空代表全部，“1”代表是，“0”代表否CONTRACTNO 合同号String30O模糊查询EDSTARTDATE出口起始日期DateOEDENDDATE出口截止日期DateOUDSTARTDATE

33、更新起始日期DateOUDENDDATE更新截止日期DateO业务规则：1、 出口起始日期和出口截止日期必须同时输入或同时为空。2、 更新起始日期和更新截止日期必须同时输入或同时为空。3、 报关单号、出口起始日期和出口截止日期、更新起始日期和更新截止日期三者不可同时为空。4、 输入报关单号，其他查询条件失效。7.1.3.2 回执报文XML节点TAG ：MSG-BODY-DATASTORES-DS1-ROWSET-ROW 标识符字段名称类型长度强制/可选备注ENTRYID 报关单号String18TXCCY 报关币种String3TXAMT 出口金额DecimalEXPDATE 出口日期Date

34、CONTRACTNO 合同号String32PREENTRYID 预录入号码String18CORPID 企业代码String9CORPNAME 企业名称GBString256PORTCODE 出口口岸String4TRADEMODE 贸易方式String4TRADECOUNTRY 抵运国String3USDAMT 成交总价折美元DecimalUPDATEDATE更新日期DateTime7.1.4 报告对应进口数据查询名称报告对应进口数据查询描述该服务为接入客户端提供可做报告对应进口数据查询服务功能，领域层接口为：SafeBaseDataService，方法名称为：doQueryBaseDat

35、aImp7.1.4.1 请求报文XML节点TAG ：MSG-BODY-DATASTORES-DS1-PARAMETERS 标识符字段名称类型长度强制/可选备注CORPID 企业代码 String9MENTRYID报关单号String18O空代表全部，“1”代表是，“0”代表否CONTRACTNO 合同号String30O模糊查询IDSTARTDATE进口起始日期DateOIDENDDATE进口截止日期DateOUDSTARTDATE更新起始日期DateOUDENDDATE更新截止日期DateO业务规则：1、 进口起始日期和进口截止日期必须同时输入或同时为空。2、 更新起始日期和更新截止日期必须

36、同时输入或同时为空。3、 报关单号、进口起始日期和进口截止日期、更新起始日期和更新截止日期三者不可同时为空。4、 输入报关单号，其他查询条件失效。7.1.4.2 回执报文XML节点TAG ：MSG-BODY-DATASTORES-DS1-ROWSET-ROW 标识符字段名称类型长度强制/可选备注ENTRYID 报关单号String18TXCCY 报关币种String3TXAMT 进口金额DecimalIMPDATE 进口日期DateCONTRACTNO 合同号String32PREENTRYID 预录入号码String18CORPID 企业代码String9CORPNAME 企业名称GBStr

37、ing256PORTCODE 进口口岸String4TRADEMODE 贸易方式String4TRADECOUNTRY 起运国String3USDAMT 成交总价折美元DecimalOWNERNAME 收货单位名称GBString256UPDATEDATE更新日期DateTime7.2 预收/预付报告7.2.1 预收/预付报告查询名称预收/预付报告查询描述该服务为接入客户端提供可做预收/预付报告查询服务功能，领域层接口为：SafeGoodsService，方法名称为：doExecuteFirstGoodsAdvancePrepaid 7.2.1.1 请求报文XML节点TAG ：MSG-BODY

38、-DATASTORES-DS1-PARAMETERS 标识符字段名称类型长度强制/可选备注TYPE 业务参数String1M“1”为预收“2”为预付CORPID 企业代码 String9MRPTNO 申报单号String22OCONTRACTNO 合同号String30O模糊查询STARTDATE 报告起始日期DateOENDDATE 报告截止日期DateO业务规则：1、 报告起始日期和报告截止日期必须同时输入或同时为空。2、 申报单号、报告起始日期和报告截止日期、合同号三者不可同时为空。3、 输入申报单号，其他查询条件失效。4、 报告起始日期和报告截止日期跨度不可超过30天，起始日期不能大于截止日期。7.2.1.2 回执报文XML节点TAG ：MSG-BODY-DATASTORES-DS1-ROWSET-ROW 标识符字段名称类型长度强制/可选备注RPTNO申报单号String22MTXCCY收付汇币种String9MTXAMT收付汇金额DecimalMRPTDATE 报告日期DateMCREDITAMT已报告金额合计DecimalMCONTRACTNO合同号（交易附言）String22OVERCODE更新日期Date