WebAPI接口之【预计可发量查询接口】使用指南和实例

栏目:云星空知识作者:金蝶来源:金蝶云社区发布:2024-09-23浏览:1

WebAPI接口之【预计可发量查询接口】使用指南和实例

【业务场景】

第三方对接系统业务单据时,可能要先查询预计可发量是否充足,以便判断是否允许对接生成业务单据,因此业务模块单独封装了【预计可发量查询】的WebAPI接口供外部调用。


【预计可发量查询接口说明及示例】

一、接口说明:

1.接口名称:GetExpectQty

   接口组件:Kingdee.K3.SCM.WebApi.ServicesStub.dll

   接口类名:Kingdee.K3.SCM.WebApi.ServicesStub.ExpectQtyQueryWebApi.cs


2.接口调用全称:

  SDK调用:Kingdee.K3.SCM.WebApi.ServicesStub.ExpectQtyQueryWebApi.GetExpectQty


  HTTP调用:http://服务器地址/k3cloud/Kingdee.K3.SCM.WebApi.ServicesStub.ExpectQtyQueryWebApi.GetExpectQty.common.kdsvc


3.接口输入参数说明:

参数名

说明
传值示例
备注说明
Row
行号
"Row": 1
可传(与结果对应匹配)
StockOrgId组织
"StockOrgId":{ "FNumber":"100" }必传(组织编码)
MaterialId物料
"MaterialId":{ "FNumber":"Mat01" }
必传(物料编码)
UnitId目标单位
"UnitId":{ "FNumber":"pcs" }选传(取物料默认单位)
StockId仓库
"StockId":{ "FNumber":"CK01" }选传(依赖参数统计维度)
LotId批号
"LotId":{ "FNumber":"Lot01" }选传(依赖参数统计维度)
BomIdBOM版本
"BomId ":{ "FNumber":"Mat01_V01" }选传(依赖参数统计维度)
ProductDate
生产日期
"ProductDate":"2023-01-01"选传(依赖参数统计维度)
ExpiryDate
到期日
"ExpiryDate":"2023-06-01"选传(依赖参数统计维度)
OwnerTypeId货主类型
"OwnerTypeId":"BD_OwnerOrg"选传(依赖参数统计维度)
OwnerId货主
"OwnerId":{ "FNumber":"100" }选传(依赖参数统计维度)
KeeperTypeId
保管者类型
"KeeperTypeId":"BD_OwnerOrg"选传(依赖参数统计维度)
KeeperId
保管者
"KeeperId":{ "FNumber":"100" }选传(依赖参数统计维度)
StockStatusId库存状态
"StockStatusId":{ "FNumber":"KCZT01_SYS" }选传(依赖参数统计维度)

AuxPropId

辅助属性

接口暂未解析

接口暂未解析(后续支持)

StockLocId

仓位

接口暂未解析

接口暂未解析(后续支持)

MtoNo

计划跟踪号

"MtoNo":"XXX"

选传(依赖参数统计维度)





4.接口输出结果说明:

字段名
字段描述
示例
Row

与请求参数匹配一致

"Row": 1,

ExpectOutBaseUnitQty

预计出(基本单位)

"ExpectOutBaseUnitQty":50,

ExpectOutQty

预计出(库存单位)

"ExpectOutQty":50,

ExpectInBaseUnitQty

预计入(基本单位)

"ExpectInBaseUnitQty":20,

ExpectInQty

预计入(库存单位)

"ExpectInQty":20,

ExpectBaseUnitQty

预计可发量(基本单位)

"ExpectBaseUnitQty":45,

ExpectQty

预计可发量(库存单位)

"ExpectQty":45,

LockBaseQty

锁库数量(基本单位)

"LockBaseQty":15,

LockQty

锁库数量(库存单位)

"LockQty":15,

KeepLockBaseQty

占用锁库数量(基本单位)

"KeepLockBaseQty":0,

KeepLockQty

占用锁库数量(库存单位)

"KeepLockQty":0,

StockBaseUnitQty

即时库存量(基本单位)

"StockBaseUnitQty":100,

StockQty

即时库存量(库存单位)

"StockQty":100,

ExpectNoInQty

预计可发量(不含预计入(库存))

"ExpectNoInQty":60,

ExpectNoInBaseUnitQty

预计可发量(不含预计入(基本))

"ExpectNoInBaseUnitQty":60,

MaterialNumber

物料编码

"MaterialNumber":"TestMat01",

UnitNumber

库存单位编码

"UnitNumber":"pcs",

BaseUnitNumber

基本单位编码

"BaseUnitNumber":"pcs",

ExtAuxUnitNumber

辅单位编码

"ExtAuxUnitNumber":"pcs",

StockId

仓库内码

"StockId":100018,

StockLocId

仓位内码

"StockLocId":0,

LotId

批号内码

"LotId":100001,

LotId_Text

批号编码

"LotId_Text":"Lot01",

OwnerType

货主类型

"OwnerType":"BD_OwnerOrg",

OwerId

货主

"OwerId":100012,

KeeperType

保管者类型

"KeeperType":"BD_KeeperOrg",

KeeperId

保管者

"KeeperId":100012,

AuxPropId

辅助属性内码

"AuxPropId":0,

BomId

Bom内码

"BomId":0,

StockStatusId

库存状态内码

"StockStatusId":10001,

ProduceDate生产日期
"/Date(-62135596800000+0800)/"
ExpiryDate到期日
"/Date(-62135596800000+0800)/"
MtoNo计划跟踪号
"MtoNo":"",
MaterialId物料内码
"MaterialId":10088,
UnitId库存单位内码
"UnitId":10010,
BaseUnitId基本单位内码
"BaseUnitId":10010,
StockOrgId库存组织内码
"StockOrgId":1,
SecUnitId辅单位内码
"SecUnitId":100010,
SecUnitQty预计可发量(辅单位)
"SecUnitQty":60,





二、接口调用示例:

<1>客户端调用示例:

1.1 构造登陆信息

//站点地址

string url = "http://domain/k3cloud/Kingdee.bos.webapi.ServicesStub.authservice.validateuser.common.kdsvc";

string dataCenterId ="账套Id";
string userName ="用户名";
string userPwd ="用户密码";

1.2 登录校验
var client = new Kingdee.BOS.WebApi.Client.K3CloudApiClient(url);
var ret = client.ValidateLogin(dataCenterId, userName, userPwd, 2052);
var jResult = JObject.Parse(ret);
var resultType = jResult["LoginResultType"].Value<int>();
if (resultType != 1 && resultType != -5) return;


1.3 构造查询预计可发量参数Demo:

string queryExpectQtyArgs="{\"Row\":1,\"StockOrgId\":{\"FNumber\":\"101.2\"},\"MaterialId\":{\"FNumber\":\"TestMat01\"}}"; 

      

1.4 客户端调用查询预计可发量接口:
 var result = client.Execute<string>("Kingdee.K3.SCM.WebApi.ServicesStub.ExpectQtyQueryWebApi.GetExpectQty", new object[]   {  queryExpectQtyArgs });        




<2>Postman测试验证:

2.1.先测试登陆接口:POST

http://domain/k3cloud/Kingdee.bos.webapi.ServicesStub.authservice.validateuser.common.kdsvc

Body录入JSON参数

{acctid:'账套Id', userName:'用户名', password:'用户密码', lcid:2052 }


2.2测试查询预计可发量接口:POST

http://domain/k3cloud/Kingdee.K3.SCM.WebApi.ServicesStub.ExpectQtyQueryWebApi.GetExpectQty.common.kdsvc


JSON参数格式样例:根据【预计可发量参数】启用的统计维度 按需构造 参数:

{ "queryExpectQtyArgs":

     [{ 

             "Row":1,
              "StockOrgId": {"FNumber": "100"},
              "MaterialId": {"FNumber":"TestMat01"},
              "UnitId":{"FNumber":"Pcs"},
              "StockId": {"FNumber":"CK01"},
              "StockStatusId": {"FNumber":"KCZT01_SYS"},
              "BomId":{"FNumber":"TestMat01_V1.0"},
              "LotText":"Lot-01",
              "ProductDate":"2022-05-21",
              "ExpiryDate":"2025-05-21",
              "Ow
nerTypeId":"BD_OwnerOrg",
              "OwnerId":{"FNumber":"100"},
              "KeeperTypeId":"BD_KeeperOrg"
,
              "KeeperId":{"FNumber":"100"},             
              "MtoNo":"M.No001"

    }]

}

Body录入json参数参数:多个物料一起查询时传数组参数Demo:

{ "queryExpectQtyArgs": 

     [{   

                  "Row":1,    

                 "StockOrgId": {"FNumber": "101.2"},    

                 "MaterialId": {"FNumber":"TestMat01"}  

      },

      {   

                  "Row":2,    

                 "StockOrgId": {"FNumber": "101.2"},    

                 "MaterialId": {"FNumber":"TestMat02"}  

      }

}


PostMan测试样例参考:


上传图片



【延伸阅读】

星空 - 《预计可发量》 精华内容合辑


WebAPI接口之【预计可发量查询接口】使用指南和实例

【业务场景】第三方对接系统业务单据时,可能要先查询预计可发量是否充足,以便判断是否允许对接生成业务单据,因此业务模块单独封装了【预...
点击下载文档
确认删除?
回到顶部
客服QQ
  • 客服QQ点击这里给我发消息