金蝶云星空接口调用详解目录

一、金蝶查询接口配置说明

金蝶云一共支持两种查询方式：

（一）、列表查询。

查询出来数据样式和在金蝶星空系统前端的对象列表一样。一张单据多条数据的情况下会显示多条记录。支持分页查询。支持一次性查询多条数据。查询的字段按照需求配置。

（二）、逐单查询。

一次查询一条数据/一张单据的完整数据。

金蝶列表查询接口注意事项

1、请求参数配置。（单据体）

a.请求参数下面每个字段对应的属性值都需要配置上对应的字段值，如果没配置会导致最终请求的结果缺少该字段；

b.根据金蝶接口api查看字段属性，部分字段启用了对象转换，这时配置请求参数字段的属性值时，需要在字段后面追加“.FNumber”;如果没有进行.FNumber转换，接口只会返回该字段对应的内码id，不是业务前端编码；
【如果是名称转换，则要使用{{字段名.FName}}；具体还需要根据金蝶api接口的实际情况配置】

2、其他请求参数&过滤条件配置。

（一）.其他请求参数：由6个参数构成

1.最大行数-Limit：
配置变量选择器的{{PAGINATION_PAGE_SIZE}}

2.开始行索引-StartRow：
配置变量选择器的{{PAGINATION_START_ROW}}

3.返回总行数-TopRowCount：
默认填写：0

4.过滤条件-FilterString：
FApproveDate>='{{LAST_SYNC_TIME|dateTime}}'
注：金蝶查询接口的过滤都在FilterString里，可以进行多条件过滤；
例如：FApproveDate>='{{LAST_SYNC_TIME|dateTime}}' and FISSALESBYNET=1 and FUseOrgId.fnumber = '100'

5.需查询的字段key集合-FieldKeys：
默认空

6.业务对象表单Id-FormId：
BD_Customer
注：查询的表单id，可以根据金蝶的表单id进行切换；
例如：查询物料则填写(BD_MATERIAL)、供应商（BD_Supplier）

（二）、过滤条件配置

（上图所示过滤条件：过滤使用组织为100且编码为0001的供应商）

1.选择【源平台配置-自定义过滤条件】，根据业务对接需求进行配置；该过滤条件支持追加多条件组合过滤，点击【+追加并且条件】进行添加条件过滤；也支持或者的过滤，点击【+追加或者条件】进行过滤；

3、响应参数配置。

响应参数配置要求，字段维护的顺序和个数需要与前面的请求参数保持一致；由于金蝶接口返回的字段是以下标的形式，所以需要我们手工维护响应参数，因此它的字段个数和顺序比较严格；否则会导致字段对应不上，影响后面配置取值

4、ID配置，校验配置。

（一）ID配置

1.选择【源平台配置-接口信息视图】，“唯一主键字段”就是“ID”，选择响应参数能有唯一代表性的字段配置；“业务编码字段”可以跟主键一致也可以不同，主要是显示作用利于查询搜索，没有唯一校验控制；

（二）校验配置

"主键检查模式"，绿色开启红色关闭；如果开启了主键检查，平台会自动校验数据，不会重复拉取单据到平台；如果涉及到修改更新场景的对接，不能启动主键检查模式，不然数据永远都不会更新。

统一查询接口（逐单查询）的应用

（一）、请求参数配置

逐单查询的请求参数 ，需要填写以下6个参数：

1.最大行数-Limit：
配置变量选择器的{{PAGINATION_PAGE_SIZE}}

2.开始行索引-StartRow：
配置变量选择器的{{PAGINATION_START_ROW}}

3.返回总行数-TopRowCount：
默认填写：0

4.过滤条件-FilterString：
FApproveDate>='{{LAST_SYNC_TIME|dateTime}}'
注：金蝶查询接口的过滤都在FilterString里，可以进行多条件过滤；
例如：FApproveDate>='{{LAST_SYNC_TIME|dateTime}}' and FISSALESBYNET=1 and FUseOrgId.fnumber = '100'

5.需查询的字段key集合-FieldKeys：
默认空

6.业务对象表单Id-FormId：
BD_Customer
注：查询的表单id，可以根据金蝶的表单id进行切换；
例如：查询物料则填写(BD_MATERIAL)、供应商（BD_Supplier）

（二）、响应参数不做要求。