金蝶K3基于WebServices外部数据交换接口使用指南

1、金蝶K/3 基于WebServices外部数据交换接口使用指南 目录概述4总体说明4通过该说明文档，你可以了解到4该文档阅读的适用对象4外部数据交换服务的安装4WebServices测试工具介绍5外部数据交换服务功能列表5公共服务 (Public.asmx)7AisQuery服务7GetAisType服务7DeleteItemQuery服务8DeleteItemUpdate服务9币别 (Currency.asmx)10Query服务10Update服务10计量单位 (MeasureUnit.asmx)12Query服务12Update服务12辅助资料 (AssistDetail.as

2、mx)14Query服务14Update服务14科目 (Account.asmx)16Query服务16Update服务16凭证字 (VoucherGroup.asmx)18Query服务18Update服务18客户 (Customer.asmx)20Query服务20Update服务20部门 (Department.asmx)22Query服务22Update服务22职员 (Employee.asmx)24Query服务24Update服务24物料或商品 (Material.asmx)26Query服务26Update服务26仓库 (Stock.asmx)28Query服务28Update服

3、务28供应商 (Supplier.asmx)30Query服务30Update服务30分支机构 (SubCompany.asmx)32Query服务32Update服务32费用(Fee.asmx)34Query服务34Update服务34工作中心 (WorkCenter.asmx)36Query服务36Update服务36工业订单与订单执行情况(InduSaleOrder.asmx)38QuerySaleOrder服务38UpdateSaleOrder服务38QueryOrderTrace服务39库存(InduStockData.asmx)40QueryWithBatch服务40QueryWi

4、thOutBatch服务40销售发票 (InduSaleInvoice.asmx)42QuerySaleInvoice服务42凭证(财务) (Voucher.asmx)43Query服务43Update服务43收款单 (ReceiveBill.asmx)45QueryReceiveBill服务45应收计划 (ArApPlan.asmx)46QueryArApPlan服务46合同(Contract.asmx)47QueryContract服务47调用方式48通过现有工具（组件）进行访问48Http方式49对象说明50应用示例51静态数据交换（基础资料）51动态数据交换（业务数据）55相关资料57

5、金蝶数据交换标准57W3C Web Service57SOAP57WebService配置57过滤条件的语法和格式57错误处理机制58安全机制58 概述总体说明我们的客户越来越成熟，在客户内部中的信息化程度也越来越高，所以使用的业务系统也越来越错综复杂，不同的系统可能跨越不同的系统平台，而客户又希望在内部的不同应用系统中可以沟通协作（术语：EAI应用）。我们金蝶的产品线也包括了ERP、CRM、OA等不同产品，而这几种产品的系统架构和设计以及应用可用的平台都有很大的差异，而要在这几个系统之间达到无缝的集成和整合。关键还在于不同的应用系统之间的数据交换（工作流也构架在数据交换的基础上）。

6、而我们设计的外部数据交换服务就是一套比较完整和合适的解决方案。可以在构建在不同的系统平台的应用系统之间实现同步、实时和增量的数据交换（静态数据和动态数据）。  注意：本篇所介绍的外部数据交换服务都是金蝶目前已经提供的服务。 注意：本篇所介绍的外部数据交换服务可向下兼容至K/3V9.2版本。通过该说明文档，你可以了解到1.        外部数据交换服务的目的、原理以及安装。2.        如何通过程序访问外部数据交换服务。

7、3.        使用外部数据交换服务的技巧和要点。4.        使用外部数据交换服务的应用示例。5.        外部数据交换服务的理论背景和相关的知识。6.        目前我们都提供了哪些外部数据交换服务。该文档阅读的适用对象需要在K/3系统上进行二次开发与K/3系统进行数据交换的行业开发者需要跟K/

8、3系统进行数据交换的第三方系统的开发人员扩展外部数据交换服务的K/3开发人员对Web Service感兴趣的开发人员外部数据交换服务的安装在K/3系统安装程序主界面，选择“外部数据交换服务部件”。安装注意： 注意：该服务必须安装K/3系统的中间层。WebServices测试工具介绍安装完成后，在开始菜单-金蝶 K3 WISE创新管理平台-金蝶K/3工具下，打开“客户端工具包”，选择“Adapter适配器”下的“k/3 WebServices”,打开后即可启动K/3 Web Services测试工具，可通过选择“服务类型”和“调用的方法”，在请求文件路径中修改测试的参数，点执行时会开展

9、WebService的测试并获取测试结果，如下图。外部数据交换服务功能列表目前K/3提供的外部数据交换服务主要有以下一些：1.         公共类：账套查询服务、查询账套类型服务等；2.         基础数据类：币别、计量单位、科目、辅助资料、客户、部门、职员、物料（商品）、供应商、分支机构、工作中心、费用、凭证字交换服务；3.         业务

10、数据类：订单交换服务、库存查询服务、合同交换服务、收款单查询服务（预收单）、应收计划查询服务、凭证交换服务、科目余额查询服务等。以上各种服务的具体使用请参考以下详细说明。 公共服务 (Public.asmx)AisQuery服务服务说明：        返回账套信息接口定义：public AisInfo AisQuery参数说明：返回信息：AisQueryResult：表示账套信息的节点组，类型：数组out string strError：返回出错信息，类型：stringGetAisType服务服务说明： 

11、;       接口定义：public string GetAisType(int iAisID,string strUser,string strPassword,out string strError)参数说明：              iAisID：账套ID，通过账套查询服务获取，类型：inteager        &

12、#160;     strUser：用户名称，必须为K/3中的合法用户，类型：string        strPassword：用户密码，目前通过明文传递，类型：string返回信息：GetAisTypeResult：表示账套类型的字符串，类型：stringout string strError：返回出错信息，类型：string返回指定账套的账套类型表示如下：类型名称账套类型返回值1工业企业全面解决方案AcctType_Industrygy2商业企业全面解决方案AcctType_Co

13、mmercesm3工业企业物流解决方案AcctType_GYWLgywl4商业企业物流解决方案AcctType_SYWLsywl5标准企业财务解决方案AcctType_QYKJqykj6集团企业财务解决方案AcctType_GRCWgrcw7行政事业财务解决方案AcctType_ZFKJzfkj8会计中心解决方案AcctType_TGZTtgzt9人力资源解决方案AcctType_RLZYrlzy DeleteItemQuery服务服务说明：        返回已经删除了的基础资料数据的关键字信息接口定义：

14、0;      public Delete DeleteItemQuery(int iAisID,                                     

15、0;                  string strUser,                              

16、                          string strPassword,                     

17、0;                                  ItemObject IO,              &

18、#160;                                         int iPerCount,      

19、0;                                                 ref strin

20、g strTimeStamp,                                               

21、60;        out string strMaxTimeStamp,                                      

22、;                  out string strError)参数说明：        iAisID：账套ID，通过账套查询服务获取，类型：int              strUser：用户名称，必须为K/3中

23、的合法用户，类型：string              strPassword：用户密码，目前通过明文传递，类型：string              IO：查询的基础资料对象类别，其值如下：Public Enum ItemObject    lAccount = 1   &

24、#160;        /科目，已实现    lAssist = 2         /辅助资料，已实现    lCurrency = 3           /币别，已实现    lMeasureUnit = 4       

25、 /计量单位，已实现    lCustomer = 5           /客户，已实现    lDepartment = 6    /部门，已实现    lEmployee = 7           /职员，已实现    lMaterial = 8 &#

26、160;         /物料（商品），已实现    lStock = 9          /仓库，已实现    lRemark = 10            /备注，预留    lSupplier = 11    

27、;      /供应商，已实现    lSonCompany = 12    /分支机构，已实现    lWorkCenter = 13        /工作中心，已实现    lcbCostObj = 14     /成本对象，预留    lcbCostItem = 15  &

28、#160;     /成本项目，预留    lcbExpense = 16     /要素费用，预留    lcbService = 17    /劳务，预留    lFee = 18               /费用，已实现    lV

29、oucherGroup = 19  /凭证字，已实现    lAuxProp = 20           /商品的辅助属性，预留    lCashFlowItem = 21  /现金流量项目，预留    lSettle = 22            /结算方式，预留End Enum&#

30、160;     iPerCount：指明返回记录条数，类型：inteager      strTimeStamp：传入起始时间辍值，默认为“0x0000000000000000”，返回当前页的最大时间辍值，类型：string返回信息： QueryResult：表示数据信息的节点组，类型：数组      strTimeStamp：返回当前页的最大时间辍值，下一页查询，将此值直接传入      &#

31、160; strMaxTimeStamp：返回所要返回记录的最大时间辍值，类型：string        strError：返回错误信息，类型：stringDeleteItemUpdate服务服务说明：        接受用户提交的基础资料数据的关键字，删除K/3的相应数据接口定义：              public b

32、ool DeleteItemUpdate(int iAisID,                                            

33、0;                  string strUser,                              

34、                                 string strPassword,              

35、0;                                                ItemObject IO,&

36、#160;                                                 &

37、#160;            Delete Data,                                    

38、                           out string strError)参数说明：              iAisID：账套ID，通过账套查询服务获取，类型：inteager 

39、;             strUser：用户名称，必须为K/3中的合法用户，类型：string              strPassword：用户密码，目前通过明文传递，类型：string             

40、; IO：查询的基础资料对象类别，见DeleteItemQuery服务              Data：业务数据，符合Schema规范，类型：数组返回信息：             UpdateResult：如果更新成功，返回为True，否则返回False，strError包含出错信息。      

41、60;          strError：返回错误信息，类型：string 币别 (Currency.asmx)Query服务服务说明：        返回满足条件的币别信息接口定义：              public Currency Query(int iAisID, 

42、0;                   string strUser,                     string strPassword,     

43、0;               int iPerCount,                     string strFilter,          &

44、#160;          ref string strTimeStamp,                     out string strMaxTimeStamp,           &#

45、160;         out string strError)参数说明：              iAisID：账套ID，通过账套查询服务获取，类型：inteager              strUser：用户名称，必须为K/3中的合法用户，类型：s

46、tring              strPassword：用户密码，目前通过明文传递，类型：string              iPerCount：查询时的每页记录条数，inteager            &

47、#160; strFilter：过滤条件，符合Sql4.0规范，类型：string      strTimeStamp：     传入起始时间辍值，默认为“0x0000000000000000”，      返回当前页的最大时间辍值，类型：string返回信息： QueryResult：表示数据信息的节点组，类型：数组      strTimeStamp：返回当前页的最大时间辍值，下一页查询，将此值直接传入

48、        strMaxTimeStamp：返回所要返回记录的最大时间辍值，类型：string        strError：返回错误信息，类型：stringUpdate服务服务说明：        接受用户提交的数据，更新K/3的币别信息接口定义：           &

49、#160;  public bool Update(int iAisID,                 string strUser,                 string strPassword,     

50、            Currency Data,                 bool bCheckByUUID,                 bool bA

51、ddNewOnly,                 out string strError)参数说明：              iAisID：账套ID，通过账套查询服务获取，类型：inteager         &

52、#160;    strUser：用户名称，必须为K/3中的合法用户，类型：string              strPassword：用户密码，目前通过明文传递，类型：string              Data：业务数据，符合Schema规范，类型：数组   

53、0;          bCheckByUUID：指明是否按UUID更新数据。True表示按UUID更新数据，False表示按Number,Name更新数据，类型：Boolean        bAddNewOnly：是否只增加记录。true表示只增加但不覆盖记录，false表示既增加又覆盖记录，类型：boolean返回信息：UpdateResult：如果更新成功，返回为True，否则返回False，strError包含出错信息。str

54、Error：返回错误信息，类型：string 计量单位 (MeasureUnit.asmx)Query服务服务说明：        返回满足条件的计量单位信息接口定义：              public MeasureUnit Query(int iAisID,          &

55、#160;          string strUser,                     string strPassword,              &

56、#160;      int iPerCount,                     string strFilter,                  

57、0;  ref string strTimeStamp,                     out string strMaxTimeStamp,                    

58、; out string strError)参数说明：              iAisID：账套ID，通过账套查询服务获取，类型：inteager              strUser：用户名称，必须为K/3中的合法用户，类型：string       

59、0;      strPassword：用户密码，目前通过明文传递，类型：string              iPerCount：查询时的每页记录条数，inteager              strFilter：过滤条件，符合Sql4.0规范，类型：string 

60、0;    strTimeStamp：传入起始时间辍值，默认为“0x0000000000000000”，返回当前页的最大时间辍值，类型：string返回信息： QueryResult：表示数据信息的节点组，类型：数组      strTimeStamp：返回当前页的最大时间辍值，下一页查询，将此值直接传入        strMaxTimeStamp：返回所要返回记录的最大时间辍值，类型：string    

61、;    strError：返回错误信息，类型：stringUpdate服务服务说明：        接受用户提交的数据，更新K/3的计量单位信息接口定义：              public bool Update(int iAisID,          

62、60;      string strUser,                 string strPassword,                 MeasureUnit Data,   

63、60;             bool bCheckByUUID,                 bool bAddNewOnly,               &#

64、160; out string strError)参数说明：              iAisID：账套ID，通过账套查询服务获取，类型：inteager              strUser：用户名称，必须为K/3中的合法用户，类型：string       &

65、#160;      strPassword：用户密码，目前通过明文传递，类型：string              Data：业务数据，符合Schema规范，类型：数组              bCheckByUUID：指明是否按UUID更新数据。True表示按UUID更新数据，Fa

66、lse表示按Number,Name更新数据，类型：Boolean        bAddNewOnly：是否只增加记录。true表示只增加不覆盖记录，false表示既增加又覆盖记录，类型：boolean返回信息：UpdateResult：如果更新成功，返回为True，否则返回False，strError包含出错信息。strError：返回错误信息，类型：string 辅助资料 (AssistDetail.asmx)Query服务服务说明：      

67、60; 返回满足条件的辅助资料信息接口定义：              public Assist Query(int iAisID,                     string strUser,     &#

68、160;               string strPassword,                     int iPerCount,         

69、60;           string strFilter,                     ref string strTimeStamp,            &#

70、160;        out string strMaxTimeStamp,                     out string strError)参数说明：              i

71、AisID：账套ID，通过账套查询服务获取，类型：inteager              strUser：用户名称，必须为K/3中的合法用户，类型：string              strPassword：用户密码，目前通过明文传递，类型：string      

72、60;       iPerCount：查询时的每页记录条数，inteager              strFilter：过滤条件，符合Sql4.0规范，类型：string      strTimeStamp：传入起始时间辍值，默认为“0x0000000000000000”，返回当前页的最大时间辍值，类型：string返回信息： QueryResult：

73、表示数据信息的节点组，类型：数组      strTimeStamp：返回当前页的最大时间辍值，下一页查询，将此值直接传入        strMaxTimeStamp：返回所要返回记录的最大时间辍值，类型：string        strError：返回错误信息，类型：stringUpdate服务服务说明：        接受用户提交

74、的数据，更新K/3的辅助资料信息接口定义：              public bool Update(int iAisID,                 string strUser,         

75、0;       string strPassword,                 Assist Data,                 bool bCheckByUUID,   

76、              bool bAddNewOnly,                 out string strError)参数说明：              iAi

77、sID：账套ID，通过账套查询服务获取，类型：inteager              strUser：用户名称，必须为K/3中的合法用户，类型：string              strPassword：用户密码，目前通过明文传递，类型：string       

78、;       Data：业务数据，符合Schema规范，类型：数组              bCheckByUUID：指明是否按UUID更新数据。True表示按UUID更新数据，False表示按Number,Name更新数据，类型：Boolean         bAddNewOnly：是否只增加记录，true表示只增加不覆盖记录，f

79、alse表示既增加又覆盖记录，类型：boolean返回信息：UpdateResult：如果更新成功，返回为True，否则返回False，strError包含出错信息。strError：返回错误信息，类型：string 科目 (Account.asmx)Query服务服务说明：        返回满足条件的科目信息接口定义：              public Account Quer

80、y(int iAisID,                     string strUser,                     string strPassword,  

81、;                   int iPerCount,                     string strFilter,      &#

82、160;              ref string strTimeStamp,                     out string strMaxTimeStamp,       

83、60;             out string strError)参数说明：              iAisID：账套ID，通过账套查询服务获取，类型：inteager              strUser

84、：用户名称，必须为K/3中的合法用户，类型：string              strPassword：用户密码，目前通过明文传递，类型：string              iPerCount：查询时的每页记录条数，inteager        &#

85、160;     strFilter：过滤条件，符合Sql4.0规范，类型：string      strTimeStamp：传入起始时间辍值，默认为“0x0000000000000000”，返回当前页的最大时间辍值，类型：string返回信息： QueryResult：表示数据信息的节点组，类型：数组      strTimeStamp：返回当前页的最大时间辍值，下一页查询，将此值直接传入     

86、60;  strMaxTimeStamp：返回所要返回记录的最大时间辍值，类型：string        strError：返回错误信息，类型：stringUpdate服务服务说明：        接受用户提交的数据，更新K/3的科目信息接口定义：              public bool Update(in

87、t iAisID,                 string strUser,                 string strPassword,          

88、60;      Account Data,                 bool bCheckByUUID,                 bool bAddNewOnly,    

89、             out string strError)参数说明：              iAisID：账套ID，通过账套查询服务获取，类型：inteager              strUser：用户

90、名称，必须为K/3中的合法用户，类型：string              strPassword：用户密码，目前通过明文传递，类型：string              Data：业务数据，符合Schema规范，类型：数组         &#

91、160;    bCheckByUUID：指明是否按UUID更新数据。True表示按UUID更新数据，False表示按Number,Name更新数据，类型：Boolean        bAddNewOnly：是否只增加记录，true表示只增加不覆盖记录，false表示既增加又覆盖记录，类型：boolean返回信息：UpdateResult：如果更新成功，返回为True，否则返回False，strError包含出错信息。strError：返回错误信息，类型：string 凭证字 (Vo

92、ucherGroup.asmx)Query服务服务说明：        返回满足条件的凭证字信息接口定义：              public VoucherGroup Query(int iAisID,                

93、     string strUser,                     string strPassword,                    

94、 int iPerCount,                     string strFilter,                     ref string strTimeStamp,&#

95、160;                    out string strMaxTimeStamp,                     out string strError)参数说明： &#

96、160;            iAisID：账套ID，通过账套查询服务获取，类型：inteager              strUser：用户名称，必须为K/3中的合法用户，类型：string              st

97、rPassword：用户密码，目前通过明文传递，类型：string              iPerCount：查询时的每页记录条数，inteager              strFilter：过滤条件，符合Sql4.0规范，类型：string      strTimeStamp：传

98、入起始时间辍值，默认为“0x0000000000000000”，返回当前页的最大时间辍值，类型：string返回信息： QueryResult：表示数据信息的节点组，类型：数组      strTimeStamp：返回当前页的最大时间辍值，下一页查询，将此值直接传入        strMaxTimeStamp：返回所要返回记录的最大时间辍值，类型：string        strError：返回错误信息

99、，类型：stringUpdate服务服务说明：        接受用户提交的数据，更新K/3的凭证字信息接口定义：              public bool Update(int iAisID,                 st

100、ring strUser,                 string strPassword,                 VoucherGroup Data,         &#

101、160;       bool bCheckByUUID,                 bool bAddNewOnly,                 out string strError)参数说明： 

102、;             iAisID：账套ID，通过账套查询服务获取，类型：inteager              strUser：用户名称，必须为K/3中的合法用户，类型：string             

103、 strPassword：用户密码，目前通过明文传递，类型：string              Data：业务数据，符合Schema规范，类型：数组              bCheckByUUID：指明是否按UUID更新数据。True表示按UUID更新数据，False表示按Number,Name更新数据，类型：Boolean

104、60;       bAddNewOnly：是否只增加记录，true表示只增加不覆盖记录，false表示既增加又覆盖记录，类型：boolean返回信息：UpdateResult：如果更新成功，返回为True，否则返回False，strError包含出错信息。strError：返回错误信息，类型：string 客户 (Customer.asmx)Query服务服务说明：        返回满足条件的客户信息接口定义：   

105、60;          public Customer Query(int iAisID,                     string strUser,            &

106、#160;        string strPassword,                     int iPerCount,                &#

107、160;    string strFilter,                     ref string strTimeStamp,                   &

108、#160; out string strMaxTimeStamp,                     out string strError)参数说明：              iAisID：账套ID，通过账套查询服务获取，类型：inteager &#

109、160;            strUser：用户名称，必须为K/3中的合法用户，类型：string              strPassword：用户密码，目前通过明文传递，类型：string              i

110、PerCount：查询时的每页记录条数，inteager              strFilter：过滤条件，符合Sql4.0规范，类型：string      strTimeStamp：传入起始时间辍值，默认为“0x0000000000000000”，返回当前页的最大时间辍值，类型：string返回信息： QueryResult：表示数据信息的节点组，类型：数组    &

111、#160; strTimeStamp：返回当前页的最大时间辍值，下一页查询，将此值直接传入        strMaxTimeStamp：返回所要返回记录的最大时间辍值，类型：string        strError：返回错误信息，类型：stringUpdate服务服务说明：        接受用户提交的数据，更新K/3的客户信息接口定义：   

112、0;          public bool Update(int iAisID,                 string strUser,                 string st

113、rPassword,                 Customer Data,                 bool bCheckByUUID,          

114、0;      bool bAddNewOnly,                 out string strError)参数说明：              iAisID：账套ID，通过账套查询服务获取，类型：inteager  

115、60;           strUser：用户名称，必须为K/3中的合法用户，类型：string              strPassword：用户密码，目前通过明文传递，类型：string              Data：业务数

116、据，符合Schema规范，类型：数组              bCheckByUUID：指明是否按UUID更新数据。True表示按UUID更新数据，False表示按Number,Name更新数据，类型：Boolean        bAddNewOnly：是否只增加记录，true表示只增加不覆盖记录，false表示既增加又覆盖记录，类型：boolean返回信息：UpdateResult：如果更新

117、成功，返回为True，否则返回False，strError包含出错信息。strError：返回错误信息，类型：string 部门 (Department.asmx)Query服务服务说明：        返回满足条件的部门信息接口定义：              public Department Query(int iAisID,    

118、0;                string strUser,                     string strPassword,        

119、0;            int iPerCount,                     string strFilter,             &

120、#160;       ref string strTimeStamp,                     out string strMaxTimeStamp,              &#

121、160;      out string strError)参数说明：              iAisID：账套ID，通过账套查询服务获取，类型：inteager              strUser：用户名称，必须为K/3中的合法用户，类型：string  &

122、#160;           strPassword：用户密码，目前通过明文传递，类型：string              iPerCount：查询时的每页记录条数，inteager              strFilter：过滤

123、条件，符合Sql4.0规范，类型：string      strTimeStamp：传入起始时间辍值，默认为“0x0000000000000000”，返回当前页的最大时间辍值，类型：string返回信息： QueryResult：表示数据信息的节点组，类型：数组      strTimeStamp：返回当前页的最大时间辍值，下一页查询，将此值直接传入        strMaxTimeStamp：返回所要返回记录的最大时间辍值

124、，类型：string        strError：返回错误信息，类型：stringUpdate服务服务说明：        接受用户提交的数据，更新K/3的部门信息接口定义：              public bool Update(int iAisID,     &#

125、160;           string strUser,                 string strPassword,                 Departm

126、ent Data,                 bool bCheckByUUID,                 bool bAddNewOnly,                 out string strError)参数说明：              iAisID：账套ID