关务云 EDI 接口 WEB SERVICE 协议接口技术文档

2609 视图

1. *** 机密，未经允许不得转发 *** 第 1 页共 44 页关务云 EDI 接口 WEB SERVICE 协议接口技术文档手册编号： SC-201905 -001 日期： 2019/05/13 广州导道信息科技有限公司

2. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档引言编写目的介绍关务云 EDI 接口 WEB SERVICE 协议接口支持的接口服务及接口调用报文结构及参数。 SOAP 协议服务接口介绍 SOAP 协议服务接口提供了可配的对外提供关务云所有单据的增、删、改、查、导入、导出六个调用 API 。用户可以通过配置实现不同应用功能组合。 *** 版权所有：广州导道信息科技有限公司 *** 第 2 页共 44 页

21. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 [[4,ID]] // 为 id=ID 的数据添加主从链接关系。 [[5]] // 删除所有的从数据的链接关系就是向所有的从数据调用 [3,ID] [[6,0,[IDs]]] // 用 IDs 里面的记录替换原来的记录 [ 就是先执行 [5] 再执行循环 IDs 执行 [4,ID]] *** 版权所有：广州导道信息科技有限公司 *** 第 21 页共 44 页

6. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 ddedi_restful_call_sync(ns1:Mandatorystring rec_json) Types (7): DDERPError ns1:Mandatorystring authentication ddedi_restful_call_edi ddedi_restful_call_ediResponse ddedi_restful_call_sync ddedi_restful_call_syncResponse Service ( SOAPSrvDDDCRestFulCallSync ) tns="http://soap11.gzdaodao.cn/ddedi" Prefixes (2) ns2 = "http://soap11.gzdaodao.cn/ddedi" ns3 = "spyne.model.primitive.string" Ports (1): (Application) Methods (2): ddedi_restful_call_edi(ns3:Mandatorystring rec_json) ddedi_restful_call_sync(ns3:Mandatorystring rec_json) Types (7): DDERPError ns3:Mandatorystring authentication ddedi_restful_call_edi ddedi_restful_call_ediResponse *** 版权所有：广州导道信息科技有限公司 *** 第 6 页共 44 页

14. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 "__get_record_by": "fields", "__get_record_fields": [ "name" ], "name": { "import": true } } }, "zggq": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "code" ], "code": { "import": true } } } } } } *** 版权所有：广州导道信息科技有限公司 *** 第 14 页共 44 页

5. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 SOAP 服务接口调用方法 SOAP 服务接口使用 SOAP V1.1 协议进行传递。接口 URL 样例： http://gzddgw.s3.guanwuyun.cn/dderp/ifapp/gzddgw.s3.guanwuyun.cn/ 4a119854fba842d890de3293c1073389?wsdl 1. 认证方法本接口提供 HTTP 认证头及 SOAP HEADER 认证头两种用户认证方式，接口调用方通过这两种方式发送我们提供的用户名及密码进行调用认证。 1.1.HTTP 认证头是符合 HTTP 标准，不在本文档描述，具体请参考相关文档。 1.2.SOAP HEADER 认证头遵循以下结构： <soapenv:Header> <auth:authentication xmlns:auth="http://soap11.gzdaodao.cn/ddedi"> <auth:username>[username]</auth:username> <auth:password>[password]</auth:password> </auth:authentication> <soapenv:Header/> 2. 关务云 EDI 接口 WEB SERVICE 协议服务的接口方法 SOAP 调用定义如下，详细接口请参考接口 WSDL 文件： Service ( SOAPSrvDDDCRestFulCallEdi ) tns="http://soap11.gzdaodao.cn/ddedi" Prefixes (2) ns0 = "http://soap11.gzdaodao.cn/ddedi" ns1 = "spyne.model.primitive.string" Ports (1): (Application) Methods (2): ddedi_restful_call_edi(ns1:Mandatorystring rec_json) *** 版权所有：广州导道信息科技有限公司 *** 第 5 页共 44 页

15. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档关务云数据模型关务云采用 ORM 技术将业务对象映射为数据库表，每个业务对象（数据模型）对应一个数据库表，每个业务记录对应数据库表的一行数据，每个业务记录均通过一个整数 ID 作为主键标识。不同业务对象通过 ID 主键字段相互关联。 1. 查询业务对象的数据模型顶层业务对象通过浏览器地址栏直接查看关联业务对象通过字段类型查询工具查看，请参考下节内容 2. 查询业务对象的字段名称及数据类型 *** 版权所有：广州导道信息科技有限公司 *** 第 15 页共 44 页

10. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 "__version": 1, //EDI 报文版本 "__generator": "DDERP1.5", //EDI 报文生成器 "__generator_version": [1, 5, 0, "final", 0, ""], //EDI 报文生成器版本 "__attachments": [], // 数据行的关联附件，使用 BASE64 编码文件内容 // 以下是正常的字段数据 "name": "\u8d35\u53f8\u5168\u79f01", "partner_id": //Many2one 关联字段以嵌套的字典导出关联单据的数据 { "__id": "base:9a99a56a-33bf-11ea-adef-525400132fd7.main_partner", "__last_update": "2020-01-20 03:53:35", "__model": "res.partner", "__module": "base", "__version": 1, "__generator": "DDERP1.5", "__generator_version": [1, 5, 0, "final", 0, ""], "__attachments": [], "name": "\u8d35\u53f8\u5168\u79f01", "street": "1860 Lyndon Street", "street_en": false } }]} 关于 ddedi_struct 参数，此参数用于指定导出数据的数据字段结构，能将关联子表字段递归导出。 *** 版权所有：广州导道信息科技有限公司 *** 第 10 页共 44 页

11. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 ddedi_struct: { '__model': '', // 数据模型，可以不填 '__module': '',// 模型所在模块，可以不填 'name': { 'export_name': 'ref_name', }, 'company_id': {//many2one 子表数据字段导出 'export_name': 'partner', 'ddedi_struct': {// 子表导出字段结构 'name': {'export': True} } }, 'address': { 'export_name': 'partner_addr', 'ddedi_struct': { 'name': {'export': True}, 'street': {'export': True}, } }, } 2.6. 导入记录导入记录支持自动创建不存在的记录或修改已存在的记录。 { "method": "ddedi_import", "model": "res.partner", "params": { //ddedi 参数存放需要导入的单据的数据字典 *** 版权所有：广州导道信息科技有限公司 *** 第 11 页共 44 页

30. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 "code": { "import": true }, "zjjg": { "import": true }, "state_id": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "name" ], "name": { "import": true } } }, "country_id": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "name" ], "name": { "import": true } } }, "zggq": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "code" ], "code": { "import": true } } *** 版权所有：广州导道信息科技有限公司 *** 第 30 页共 44 页

31. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 } } }, "kehu_code": { "import": true }, "partner_bg": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "name" ], "name": { "import": true } } }, "ieflag": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "name" ], "name": { "import": true } } }, "tj": { "import": true }, "dd_note": { "import": true }, "custommaster": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ *** 版权所有：广州导道信息科技有限公司 *** 第 31 页共 44 页

32. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 "zh_name" ], "zh_name": { "import": true } } }, "manualno": { "import": true }, "trade": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "name" ], "name": { "import": true } } }, "contrno": { "import": true }, "owner": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "name" ], "name": { "import": true } } }, "ext_partner": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", *** 版权所有：广州导道信息科技有限公司 *** 第 32 页共 44 页

33. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 "__get_record_fields": [ "name" ], "name": { "import": true } } }, "voyagenno": { "import": true }, "trafmode": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "zh_name" ], "zh_name": { "import": true } } }, "trafname": { "import": true }, "billno": { "import": true }, "trademode": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "zh_name" ], "zh_name": { "import": true } } }, "cutmode": { *** 版权所有：广州导道信息科技有限公司 *** 第 33 页共 44 页

34. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "zh_name" ], "zh_name": { "import": true } } }, "licenseno": { "import": true }, "tradecountry": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "name" ], "name": { "import": true } } }, "distinateport": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "zh_name" ], "zh_name": { "import": true } } }, "transmode": { "import": true, "ddedi_struct": { *** 版权所有：广州导道信息科技有限公司 *** 第 34 页共 44 页

35. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "name" ], "name": { "import": true } } }, "feerate": { "import": true }, "feecurr": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "name" ], "name": { "import": true } } }, "feemark": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "name" ], "name": { "import": true } } }, "insurrate": { "import": true }, "insurcurr": { "import": true, *** 版权所有：广州导道信息科技有限公司 *** 第 35 页共 44 页

36. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "name" ], "name": { "import": true } } }, "insumark": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "name" ], "name": { "import": true } } }, "otherrate": { "import": true }, "othercurr": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "name" ], "name": { "import": true } } }, "othermark": { "import": true, "ddedi_struct": { "__update_exists": false, *** 版权所有：广州导道信息科技有限公司 *** 第 36 页共 44 页

37. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 "__get_record_by": "fields", "__get_record_fields": [ "name" ], "name": { "import": true } } }, "packno": { "import": true }, "wraptype": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "zh_name" ], "zh_name": { "import": true } } }, "grosswet": { "import": true }, "netwt": { "import": true }, "tradeareacode": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "name" ], "name": { "import": true } } }, *** 版权所有：广州导道信息科技有限公司 *** 第 37 页共 44 页

38. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 "entryportcode": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "zh_name" ], "zh_name": { "import": true } } }, "despportcode": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "zh_name" ], "zh_name": { "import": true } } }, "entrytype": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "zh_name" ], "zh_name": { "import": true } } }, "notes": { "import": true }, "markno": { "import": true *** 版权所有：广州导道信息科技有限公司 *** 第 38 页共 44 页

39. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 }, "price_effect": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "zh_name" ], "zh_name": { "import": true } } }, "chksurety": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "zh_name" ], "zh_name": { "import": true } } }, "special_rel": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "zh_name" ], "zh_name": { "import": true } } }, "special_payment": { "import": true, "ddedi_struct": { "__update_exists": false, *** 版权所有：广州导道信息科技有限公司 *** 第 39 页共 44 页

40. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 "__get_record_by": "fields", "__get_record_fields": [ "zh_name" ], "zh_name": { "import": true } } }, "declist": { "import": true, "ddedi_struct": { "__update_exists": true, "__get_record_by": "external_id", "gno": { "import": true }, "declare": { "import": true }, "contritem": { "import": true }, "spzhfl": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "code" ], "code": { "import": true } } }, "wlbm": { "import": true }, "product": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", *** 版权所有：广州导道信息科技有限公司 *** 第 40 页共 44 页

41. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 "__get_record_fields": [ "default_code" ], "default_code": { "import": true } } }, "pplx": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "code" ], "code": { "import": true } } }, "ckxhqk": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "code" ], "code": { "import": true } } }, "gname": { "import": true }, "gmodel": { "import": true }, "gqty": { "import": true }, "gunit": { *** 版权所有：广州导道信息科技有限公司 *** 第 41 页共 44 页

42. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "name" ], "name": { "import": true } } }, "declprice": { "import": true }, "decltotal": { "import": true }, "tradecurr": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "name" ], "name": { "import": true } } }, "firstqty": { "import": true }, "secondqty": { "import": true }, "netwt": { "import": true }, "origincountry": { "import": true, "ddedi_struct": { "__update_exists": false, *** 版权所有：广州导道信息科技有限公司 *** 第 42 页共 44 页

43. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 "__get_record_by": "fields", "__get_record_fields": [ "name" ], "name": { "import": true } } }, "destinationcountry": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "name" ], "name": { "import": true } } }, "dutymode": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "zh_name" ], "zh_name": { "import": true } } }, "useto": { "import": true, "ddedi_struct": { "__update_exists": false, "__get_record_by": "fields", "__get_record_fields": [ "zh_name" ], "zh_name": { *** 版权所有：广州导道信息科技有限公司 *** 第 43 页共 44 页

29. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 "dutymode": { "zh_name": " 全免 " }, "useto": { "zh_name": " 其他 " } } ] }, "ddedi_struct": { "__update_exists": true, "partner": { "import": true, "ddedi_struct": { "__model": "", "__module": "", "__update_exists": true, "__get_record_by": "fields", "__get_record_fields": [ "name" ], "__no_create": false, "name": { "import": true }, "company_type": { "import": true }, "street": { "import": true }, "street_en": { "import_name": "street2" }, "ptjc": { "import": true }, "city": { "import": true }, "comment": { "import": true }, *** 版权所有：广州导道信息科技有限公司 *** 第 29 页共 44 页

25. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 }, "tj": 12.2, "dd_note": " 急货 ", "custommaster": { "zh_name": " 广州海关 " }, "manualno": "", "trade": { "name": "test01" }, "contrno": "PO0002", "owner": { "name": "test01" }, "ext_partner": { "name": "test2" }, "voyagenno": "67890", "trafmode": { "zh_name": " 水路运输 " }, "trafname": "2222", "billno": "5678", "trademode": { "zh_name": " 一般贸易 " }, "cutmode": { "zh_name": " 一般征税 " }, "licenseno": "", "tradecountry": { "name": " 美国 " }, "distinateport": { "zh_name": " 名古屋（日本） " }, "transmode": { "name": "CIF" }, "feerate": 10, "feecurr": { "name": "USD" }, "feemark": { *** 版权所有：广州导道信息科技有限公司 *** 第 25 页共 44 页

27. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 }, "special_payment": { "zh_name": " 空 " }, "declist": [ { "__id": "base:b2fc4a4f-d7a9-4e45-8444- 0bb110257c9e.declist00000001", "gno": 1, "contritem": "", "spzhfl": { "code": "8443999090" }, "wlbm": "P0001", "product": { "default_code": "P0001" }, "pplx": { "code": "0" }, "ckxhqk": { "code": "0" }, "gname": " 墨水流路组件 ", "gmodel": "0|0| 打印机印头墨水传输及控制 | 无品牌 | 无型号 |||", "gqty": 20, "gunit": { "name": " 个 " }, "declprice": 50, "decltotal": 1000, "tradecurr": { "name": "USD" }, "firstqty": 11, "secondqty": 0, "netwt": 11.0, "origincountry": { "name": " 日本 " }, "destinationcountry": { "name": " 中国 " }, "dutymode": { *** 版权所有：广州导道信息科技有限公司 *** 第 27 页共 44 页

28. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 "zh_name": " 全免 " }, "useto": { "zh_name": " 其他 " } }, { "__id": "base:b2fc4a4f-d7a9-4e45-8444- 0bb110257c9e.declist00000002", "gno": 2, "contritem": "", "spzhfl": { "code": "8544491900" }, "wlbm": "P0002", "product": { "default_code": "P0002" }, "pplx": { "code": "0" }, "ckxhqk": { "code": "0" }, "gname": " 连接线 ", "gmodel": "0|0| 复印机用 | 无接头 | 无品牌 | 无型号 |≤80V|||", "gqty": 1, "gunit": { "name": " 千克 " }, "declprice": 8, "decltotal": 8, "tradecurr": { "name": "USD" }, "firstqty": 1, "secondqty": 0, "netwt": 1, "origincountry": { "name": " 日本 " }, "destinationcountry": { "name": " 中国 " }, *** 版权所有：广州导道信息科技有限公司 *** 第 28 页共 44 页

8. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 "params": {"ids": [1,2]}}}// 需要删除的数据 IDS 成功时返回值： {"flag": true, "message": "message": " 接口调用返回可阅读信息 ", "data": {"ids": [1,2,3]}}// 返回成功删除记录的 ID 2.3. 修改记录 { "method": "write", "model": "res.company", // 数据模型 "params": { "id": 1, // 需要修改的数据 ID "vals": {"name": "ddaa"}}}// 需要修改的字段及其值，参数 vals 是单据字段的数据字典，关于关务云数据字典的结构及用法请参考 “ 关务云接口数据字典 ”章节成功时返回值： {"flag": true, "message": "message": " 接口调用返回可阅读信息 ", "data": {"id": 1}}// 返回成功修改记录的 ID 2.4. 查询记录 { "method": "search", "model": "res.company", // 数据模型 "params": { "domain": ["|", ["create_date", "<", "2019-08-01"], ["create_date", ">", "2018-08- 01"]], // 查询参数，使用波兰表达式语法，支持对象层级属性查询 , 查询参数的具体用法请参考 “ 关务云接口查询表达式语法 ”章节。 "fields": ["id", "name"]}}// 需要返回的字段数据成功时返回值： {"flag": true, "message": "message": " 接口调用返回可阅读信息 ", "data": [{"id": 6, "name": "ddaa"},{"id": 7, "name": "da"}]}// 返回符合查询条件记录的数据 2.5. 导出记录 { *** 版权所有：广州导道信息科技有限公司 *** 第 8 页共 44 页

26. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 "name": " 运费总价 " }, "insurrate": 10, "insurcurr": { "name": "USD" }, "insumark": { "name": " 保费总价 " }, "otherrate": 10, "othercurr": { "name": "USD" }, "othermark": { "name": " 杂费总价 " }, "packno": 10, "wraptype": { "zh_name": " 再生木托 " }, "grosswet": 15, "netwt": 12, "tradeareacode": { "name": " 中国 " }, "entyportcode": { "zh_name": " 广州 " }, "despportcode": { "zh_name": " 黄埔（中国） " }, "entrytype": { "zh_name": " 通关无纸化 " }, "notes": "", "markno": "N/M", "price_effect": { "zh_name": " 是 " }, "chksurety": { "zh_name": " 是 " }, "special_rel": { "zh_name": " 空 " *** 版权所有：广州导道信息科技有限公司 *** 第 26 页共 44 页

19. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档关务云接口数据字典本章节的数据字典仅适用于 create,write 方法。 ddedi_import 与 ddedi_export 的数据字典请参考接口章节。 1. 数据类型对应关系关务云字段类型 JSON 字段类型 char 字符串 selection 字符串 int 数字 float 数字 text 字符串 html 字符串 boolean 布尔 date 字符串 datetime 字符串（格林威治时间， 0 时区） many2one 数字 one2many 数组 many2many 数组 2. 数据结构关务云数据字典是就是一个 JSON 对象， JSON 对象属性对应业务单据的字段。业务单据字段的名查询方法请参考 “ 关务云数据模型 ”章节。例如以下联系人数据字典： { "name": " 测试客户 001 有限公司 ", "company_type": "company", //selection 类型字段需要填写英文字段值，使用调试模式查看字段的英文字段值。 "street": " 广州市天河区中山大道 100 号 1001 室内 ", "street_en": "Room 1001, No. 100 Zhongshan Avenue, Tianhe District, Guangzhou", "ptjc": " 测试客户 001", "city": " 广州市 ", *** 版权所有：广州导道信息科技有限公司 *** 第 19 页共 44 页

7. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 ddedi_restful_call_sync ddedi_restful_call_syncResponse ddedi_restful_call_edi(ns3:Mandatorystring rec_json) 对应 EDI 调用， EDI 调用属于异步调用，用于高并发场景，较为复杂，本文档不做介绍。如业务需要使用请到关务云商城购买咨询服务。 ddedi_restful_call_sync(ns3:Mandatorystring rec_json) 对应同步调用其中参数 rec_json 是封装了调用报文的 JSON 字符串。本接口应用为提供接口配置模型提供：增、删、改、查、导入、导出六种方法调用。返回值为 JSON 字符串。返回值结构如下：成功： {"flag": true, "message": " 接口调用返回可阅读信息 ", "data": "JSON 字符串 "} 失败： {"flag": false, "message": " 接口调用失败！ "} ，调用异常时将使用 SOAP 的异常处理节点 <Fault/> 对异常报文进行封装。报文样例如下 rec_json ： 2.1. 添加记录 { "method": "create", "model": "res.company", // 数据模型，关于数据模型请参考 “ 关务云数据模型 ”章节 "params": {"vals": {"name": "ddaa"}}}// 参数 vals 是单据字段的数据字典，关于关务云数据字典的结构及用法请参考 “ 关务云接口数据字典 ”章节成功时返回值： {"flag": true, "message": "message": " 接口调用返回可阅读信息 ", "data": {"ids": [1,2,3]}}// 返回成功创建记录的 ID 2.2. 删除记录 { "method": "unlink", "model": "res.company", // 数据模型 *** 版权所有：广州导道信息科技有限公司 *** 第 7 页共 44 页

4. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档目录 SOAP 服务接口调用方法 ............................................................................................................................. 5 1. 认证方法 ...................................................................................................................................................... 5 2. 关务云 EDI 接口 WEB SERVICE 协议服务的接口方法 ............................................................................... 5 2.1. 添加记录 ............................................................................................................................................... 7 2.2. 删除记录 ............................................................................................................................................... 7 2.3. 修改记录 ............................................................................................................................................... 8 2.4. 查询记录 ............................................................................................................................................... 8 2.5. 导出记录 ............................................................................................................................................... 8 2.6. 导入记录 ............................................................................................................................................. 11 关务云数据模型 ........................................................................................................................................ 15 1. 查询业务对象的数据模型 ......................................................................................................................... 15 2. 查询业务对象的字段名称及数据类型 ..................................................................................................... 15 关务云接口数据字典 ................................................................................................................................ 19 1. 数据类型对应关系 ..................................................................................................................................... 19 2. 数据结构 .................................................................................................................................................... 19 3. 关系型字段 ( ONE 2 MANY ) .............................................................................................................................. 20 4. 关系型字段 ( MANY 2 MANY ) ............................................................................................................................ 20 关务云接口查询表达式语法 ..................................................................................................................... 22 1.DOMAIN 查询表达式 .................................................................................................................................. 22 2. 字段名 ........................................................................................................................................................ 22 3. 操作符 ........................................................................................................................................................ 22 4. 值 ................................................................................................................................................................ 23 5. 逻辑运算符 ................................................................................................................................................ 23 关务云 EDI 导入报文参数实例 .................................................................................................................... 24 1. 报关单 EDI 导入 ........................................................................................................................................... 24 *** 版权所有：广州导道信息科技有限公司 *** 第 4 页共 44 页

9. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 "method": "ddedi_export", "model": "res.company", // 数据模型 "params": { "ids": [2171], // 需要导出的数据 IDS "ddedi_struct": { // 需要导出的数据字段结构，支持层级导出 "__no_attachments": false, // 不导出附件 "name": {"export": true}, "partner_id": { // 导出关联子表 "export": true, "ddedi_struct": { "__no_attachments": false, // 不导出附件 "name": {"export": true}, "street": {"export": true}, "street2": {"export_name": "street_en"},// 可重命名字段名的输出 } }}}} 返回值： {"flag": true, "message": "RESTFUL\u8c03\u7528\u6210\u529f", "data": [ // “__” 开头的是内置信息字段，每个记录都会有包括嵌套的关联记录 {"__id": "base:9a99a56a-33bf-11ea-adef-525400132fd7.main_company", // 数据行外部 ID ，形式： “ 模块名 : 数据库 ID: 数据行 ID” ，外部 ID 用于存放外部系统的数据 ID ，通过外部 ID 关务云可以判断数据是否已经存在，如果已存在就修改数据否则创建新的记录。 "__last_update": "2020-01-09 12:44:29", // 最后更新时间 "__model": "res.company", // 数据模型 "__module": "base", // 数据模型所在模块 *** 版权所有：广州导道信息科技有限公司 *** 第 9 页共 44 页

24. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档关务云 EDI 导入报文参数实例以下实例只列出 rec_json 参数的内容， SOAP 协议属于标准协议，这里不列出完整 XML 报文，请使用相关 SOAP 工具生成报文和调用接口测试。 1. 报关单 EDI 导入 { "method": "ddedi_import", "model": "dd.erp.hg_declare", "params": { "ddedi": { "__id": "base:b2fc4a4f-d7a9-4e45-8444- 0bb110257c9e.declare00000001", "partner": { "name": " 测试客户 001 有限公司 ", "ptjc": " 测试客户 001", "company_type": "company", "street": " 广州市天河区中山大道 100 号 1001 室内 ", "street_en": "Room 1001, No. 100 Zhongshan Avenue, Tianhe District, Guangzhou", "city": " 广州市 ", "state_id": { "name": " 广东省 " }, "country_id": { "name": " 中国 " }, "comment": " 内部备注测试 ", "zggq": { "code": "5100" }, "code": "1234567890", "zjjg": "91xxxxxxxxxxx" }, "kehu_code": "CS-200206-0002", "partner_bg": { "name": " 贵司全称 1" }, "ieflag": { "name": " 进口 " *** 版权所有：广州导道信息科技有限公司 *** 第 24 页共 44 页

13. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 "street": { "import": true }, "street_en": { "import_name": "street2" // 如果数据字段的字段名与系统的字段名不同，可以通过 “ import_name” 指定数据字典中的字段名对应的系统字段 }, "ptjc": { "import": true }, "city": { "import": true }, "comment": { "import": true }, "code": { "import": true }, "zjjg": { "import": true }, "state_id": {//Many2one 子表数据一次性导入 "import": true, "ddedi_struct": { "__update_exists": false,// 如果记录不存在， false 不允许创建直接报错， true 自动创建记录。 "__get_record_by": "fields", //__get_record_by==‘fields’ 时指定字段列表用于获取已存在的记录 , // 只支持 integer,float,boolean,char,text 等简单字段 "__get_record_fields": [ "name" ], "name": { "import": true } } }, "country_id": { "import": true, "ddedi_struct": { "__update_exists": false, *** 版权所有：广州导道信息科技有限公司 *** 第 13 页共 44 页

20. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 "state_id": 712, //many2one 类型字段填写关联记录的数字 ID ，可通过接口的 search 方法获取 ID 。 "country_id": 48, //many2one 类型字段填写关联记录的数字 ID ，可通过接口的 search 方法获取 ID 。 "comment": " 内部备注测试 ", "zggq": 496, //many2one 类型字段填写关联记录的数字 ID ，可通过接口的 search 方法获取 ID 。 "code": "1234567890", "zjjg": "91xxxxxxxxxxx", //one2many 字段 "hgdzzc": [ [0, 0, { "name": "1234567890", "code": "GZDD7890", }] } 3. 关系型字段 (one2many) one2many 类型字段在数据字典中按以下方式填写： [ [0, 0,{ values }], [0, 0,{ values }] ] // 根据 values 里面的信息新建一个或多个记录 , [[1,ID,{values}]] // 更新 id=ID 的记录（对 id=ID 的执行 write 写入 values 里面的数据） [[2,ID1], [2, ID2]] // 删除 id=ID 的数据（调用 unlink 方法，删除数据以及整个主从数据链接关系） 4. 关系型字段 (many2many) [[0,0,{values}]] // 根据 values 里面的信息新建一个记录。 [[1,ID,{values}]] // 更新 id=ID 的记录 [ 写入 values 里面的数据 ] [[2,ID]] // 删除 id=ID 的数据 [ 调用 unlink 方法，删除数据以及整个主从数据链接关系 ] [[3,ID]] // 切断主从数据的链接关系但是不删除这个数据 *** 版权所有：广州导道信息科技有限公司 *** 第 20 页共 44 页

22. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档关务云接口查询表达式语法关务云查询接口报文查询表达式采用波兰表达式的对象查询语言进行查询。 1.DOMAIN 查询表达式最简单的格式： [[' 字段名 ',' 操作符 ', 值 ]] 例： [['partner.name','=',' 测试 ']] 其中 [' 字段名 ',' 操作符 ', 值 ] 为子表达式，多个子表达式可以已波兰表达式规则通过逻辑运算符连接，实现复杂查询。例 1, 或运算： ['|', ['partner.name','=',' 测试 '], ['partner.name','=',' 测试 ']] 例 2, 与运算： ['&', ['partner.name','=',' 测试 '], ['partner.mobile','=','13900000000']] 2. 字段名子表达式的第一个元素是数据模型的字段名，如果是 Many2one/Many2Many/ One2many 字段，可以通过 '.' 取出对应的属性，如： ('create_uid.company_id.parent_id','=', user.company_id.id) 3. 操作符子表达式的第二个元素是操作符操作符说明 =,>.<,>=,<=,! = 比较运算，等于，不等于，大于，大于等于，小于，小于等于 like 模糊匹配，通过 %value% 匹配 =like 可以使用模式匹配，下划线 - 匹配一个字符，百分号 % 匹配零或者多个字符 ilike 类似 like ，但是忽略大小写 =ilike 类似 =like ，但是忽略大小写 not like 通过 %value% 不匹配的 not ilike 类似 not like ，但是忽略大小写 *** 版权所有：广州导道信息科技有限公司 *** 第 22 页共 44 页

12. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档 " ddedi ": { "__id": "base:b2fc4a4f-d7a9-4e45-8444-0bb110257c9e.pt0001", // 数据外部 ID ，格式：模块 : 数据库 UUID. 记录 ID "name": " 测试客户 001 有限公司 ", "company_type": "company", "street": " 广州市天河区中山大道 100 号 1001 室内 ", "street_en": "Room 1001, No. 100 Zhongshan Avenue, Tianhe District, Guangzhou", "ptjc": " 测试客户 001", "city": " 广州市 ", "state_id": { "name": " 广东省 " }, "country_id": { "name": " 中国 " }, "comment": " 内部备注测试 ", "zggq": { "code": "5100" }, "code": "1234567890", "zjjg": "91xxxxxxxxxxx" }, // 关于 ddedi_struct 参数，此参数用于指定导入数据的数据字段结构，能将关联子表字段递归导入。 "ddedi_struct ": { "__model": "", // 替换要导入的 model , 可以不填 "__module": "", // 替换要导入的 module , 可以不填 "__update_exists": true, // 更新已存在的记录，当存在与“ __id” 相同的记录时执行记录的更新。 "__get_record_by": "external_id", // 指定获取已存在记录的方法，用于检查记录是否已经存在： external_id 按外部 ID(__id 字段值 ) 获取 , fields 按字段值获取。 "__no_create": false, // 如果记录不存在， false 不允许创建直接报错， true 自动创建记录。 // 指定要导入的字段 "name": { "import": true // 声明此字段要导入 }, "company_type": { "import": true }, *** 版权所有：广州导道信息科技有限公司 *** 第 12 页共 44 页

23. 关务云 EDI 接口 WEB SERVICE 协议接口技术文档操作符说明 =? 未设置或者等于，未设置表示当值是 NULL 或者是 False ，其余和 = 一样 in 判断 value 是否在元素的列表里面 not in 判断 value 是否不再元素的列表里面 child_of 判断是否 value 的子记录 ,[(A,'child_of',A)] 返回 true parent_of 判断是否 value 的父记录 ,[(A,'child_of',A)] 返回 true 4. 值子表达式的第三个元素是比较值，代表当子表达式第一个元素的字段值与值比较的结果。包括字符串， true 或 false ，数字等 5. 逻辑运算符多个子表达式支持逻辑运算。逻辑运算符说明 & 与运算，二元运算符 | 或运算，二元运算符 ! 取反运算，一元运算符波兰表示法的运算顺序以二元运算为例，从左至右读入表达式，遇到一个操作符后跟随两个操作数时，则计算之，然后将结果作为操作数替换这个操作符和两个操作数；重复此步骤，直至所有操作符处理完毕。 ['|','&','|',a,b,c,'&',d,e] 其中 a,b,c,e,f,g 分别是不带逻辑运算符的表达式，表达式的运算顺序，（以下例子的括号只是为了表达运算顺序，实际的表达式不允许通过括号定义运算优先级）： ['|','&','|',a,b,c,'&',d,e] ['|','&',(a | b),c,'&',d,e] ['|',((a | b) & c),'&',d,e] ['|',((a | b) & c),(d & e)] [(((a | b) | c) | (d & e))] *** 版权所有：广州导道信息科技有限公司 *** 第 23 页共 44 页

视图

2609 全部视图
1971 网站视图
638 嵌入的视图

动作

0 社区分享
0 喜欢
0 不喜欢
0 评论

分享数

0 Facebook
0 推特
0 领英
0 谷歌+

关务云 EDI 接口 WEB SERVICE 协议接口技术文档

视图

动作

分享数

嵌入 1

“单一窗口”数据对接客户端申请

核注清单操作手册

报关单操作手册

海关接口申请手册

系统通用基本操作

出入库单操作手册

业务申报表操作手册

关务系统管理员手册

关务云管理后台使用手册

单个公司配置多个发送通道

ERP、WMS、OMS对接接口配置手册

如何成为关务云经销商

报关管理系统(含物流仓库模块)

出口管理系统方案

报关管理系统(无仓库物流)

供应链管理系统介绍

如何购买SAAS服务

关务云经销商政策

关务云经销商政策(2024)

关务云 EDI 接口 WEB SERVICE 协议接口技术文档

分享到社交网络

分享链接

与朋友分享

嵌入你的网页

视图

动作

分享数

嵌入 1

“单一窗口”数据对接客户端申请

海关接口申请手册

单个公司配置多个发送通道

关务系统管理员手册

系统通用基本操作

报关单操作手册

核注清单操作手册

业务申报表操作手册

出入库单操作手册

ERP、WMS、OMS对接接口配置手册

“单一窗口”数据对接客户端申请

核注清单操作手册

报关单操作手册

海关接口申请手册

系统通用基本操作

出入库单操作手册

业务申报表操作手册

关务系统管理员手册

关务云管理后台使用手册

单个公司配置多个发送通道

ERP、WMS、OMS对接接口配置手册

如何成为关务云经销商

报关管理系统(含物流仓库模块)

出口管理系统方案

报关管理系统(无仓库物流)

供应链管理系统介绍

如何购买SAAS服务

关务云经销商政策

关务云经销商政策(2024)