K/3 Cloud Web API 接口说明文档
K/3 Cloud Web API 接口说明文档
目的
三方集成,提供第三方系统与 Cloud 集成调用接口。
技术实现
HTTP + Json
提供标准接口
编号 名称
1
2
3
4
5
6
7
8
用户验证
Kingdee.BOS.WebApi.ServicesStub.AuthService.ValidateUser
Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Save
Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Audit
Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Delete
Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.UnAudit
Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Submit
Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.View
Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.StatusConvert 状态转换
反审核
提交
查看
说明
保存
审核
删除
示例
三方客户端 引用 Kingdee.BOS.WebApi.Client.dll(注:此客户端引用 Api 封装的是 Http 请求)。
币别->保存 示例
public void TestMethodSave_BD_Currency()
{
//Cloud 业务站点Url
第 1页 /共 8页
K/3 Cloud Web API 接口说明文档
ApiClient client = new ApiClient("http://localhost:1200/");
//调用登陆接口 参数 数据中心Id,用户名,密码,语言id
bool ret = client.Login("005056a30125ad4311e40291d44c593a",
"Administrator", "888888", 2052);
// 登陆成功
if (ret)
{
//业务对象Id
string sFormId = "BD_Currency";
//Json字串
string sJson = "{\"Creator\":\"三方调用者标识
\",\"NeedUpDateFields\":[\"FNumber\",\"FName\",\"FCODE\"],\"Model\":{\"FCURRENC
YID\":0,\"FNumber\":\"编码\",\"FName\":\"名称\",\"FCODE\":\"货币代码
\",\"FPRICEDIGITS\":4,\"FAMOUNTDIGITS\":2,\"FPRIORITY\":0,\"FIsTrans\":false,\"
FIsShowCSymbol\":false,\"FIsSysPreset\":false,\"FDescription\":\"info\"}}";
object[] saveInfo = new object[]
{
sFormId,
sJson
};
//调用保存接口
client.Execute("Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Save
", saveInfo);
}
}
示例说明:
其中主要关注构造的 Json 字串
通过 Json 编译工具,可查看及构造相应 Json 数据
第 2页 /共 8页
K/3 Cloud Web API 接口说明文档
Json 数据是币别界面字段对应的。
包含单据体的 Json 数据构造:
凭证界面构造的 Json 数据,如下图:
第 3页 /共 8页
K/3 Cloud Web API 接口说明文档
第 4页 /共 8页
K/3 Cloud Web API 接口说明文档
财务总账凭证保存
在对接之前先熟悉总账流程,在新建账簿、结束初始化等等动作之后,便可以开始对接。注意,该文档凭
证只对接到科目,不涉及核算维度。
DoNet 环境下 demo
// 使用 webapi 引用组件 Kingdee.BOS.WebApi.Client.dll
//Cloud 3.0
public void TestMethodSave_GL_VOUCHER()
{
//Cloud 业务站点 Url
ApiClient client = new ApiClient("http://localhost:1200/");
//调用登陆接口 参数 数据中心 Id,用户名,密码,语言 id
bool ret = client.Login("005056a30125ad4311e40291d44c593a", "Administrator",
"888888", 2052);
// 登陆成功
if (ret)
{
//业务对象 Id 凭证,这里无需修改
string sFormId = "GL_VOUCHER";
//Json 字串
string sJson =
"{\"Creator\":\"String\",\"NeedUpDateFields\":[\"String\"],\"Model\":{\"FVOUCHERID\":0,\"FAcco
untBookID\":{\"FNumber\":\"004\"},\"FDate\":\"2012-1-31\",\"FSystemID\":{\"FNumber\":\"gl\"},\
"FVOUCHERGROUPID\":{\"FNumber\":\"PRE001\"},\"GL_VOUCHER__FEntity\":[{\"FEXPLANATION
\":\"11\",\"FACCOUNTID\":{\"FNumber\":\"1001\"},\"FDEBIT\":\"100\"},{\"FEXPLANATION\":\"22\",
\"FACCOUNTID\":{\"FNumber\":\"1101\"},\"FCREDIT\":\"100\"}]}}";
object[] saveInfo = new object[]
{
sFormId,
sJson
};
//调用保存接口
client.Execute("Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Save",
saveInfo);
}
}
第 5页 /共 8页
K/3 Cloud Web API 接口说明文档
Json 字串参数说明
Json 对应树结构参考上面的图
参数名
FVOUCHERID
字段类型
Int
FAccountBookID.FNumber
nvarchar(50)
FDate
FSystemID.FNumber
FVOUCHERGROUPID.
FNumber
date
nvarchar(50)
nvarchar(50)
说明
凭证 ID,如果是新增,默认给 0,如果是修改,对应
凭证的 ID,大于 0
FAccountBookID 对应账簿,FNumber 对应账簿的内
码。账簿请参考:【总账】-【账簿】
凭证日期,一般给当前日期
FSystemID 对应来源系统,FNumber 对应来源系统编
码,这里可以给默认“GL”
FVOUCHERGROUPID 对应凭证字,FNumber 凭证字
的内码。通常为:记、
收、付、转,对应的值分别为:PRE001、
PRE002、PRE003、PRE004。如果需要自定义请参考:
【总账】-【币别】
GL_VOUCHER__FEntity
FEXPLANATION
FACCOUNTID.FNumber
FDEBIT
FCREDIT
----------------- 凭证分录信息节点,无需修改
nvarchar(500)
nvarchar(50)
摘要信息
FACCOUNTID 对应科目,FNumber 对应科目内码。
对接到 K3/CLOUD 总账系统具体那个科目,请参考【总
账】-【科目】
decimal(23,10) 借方金额
decimal(23,10) 贷方金额,注意:同一张凭证多分录借贷平衡
金蝶 K3cloud json 格式查询方式
1、
第 6页 /共 8页
K/3 Cloud Web API 接口说明文档
2、
3、
第 7页 /共 8页
K/3 Cloud Web API 接口说明文档
第 8页 /共 8页