SparkPackERP接口
- SparkPackERP认证（Login）
接口地址
/id/SparkPackERPs/v1/Login
接口API功能描述
登录SparkPackERP
调用方式
Post
接口备注
返回参数中的SessionId会使用在后续流程接口的请求头中
请求体参数
参数名称
参数描述
参数类型
参数说明
CompanyDB
账套数据库
String
登录的SparkPackERP账套库名
UserName
用户名
String
登录使用的账号
Password
用户密码
String
登录使用的账号密码
请求样例：
{
"CompanyDB": "SBODEMOCN ",
"UserName": "xxxxx",
"Password": "password"
}
返回参数
参数名称
上级参数
参数描述
参数类型
参数说明
SessionId
会话标识
String
在后续流程接口的请求头中的cookie里使用，成功时返回
Version
SparkPackERP版本号
String
成功时返回
SessionTimeout
SessionId时间限制
Int
默认30分钟，成功时返回
error
失败信息
List
失败时返回
code
error
错误代码
Int
SparkPackERP错误代码，失败时返回
message
error
错误信息
List
失败时返回
value
message
错误详情
String
SparkPackERP错误消息，失败时返回
返回样例：
（1）成功样例
{
"odata.metadata":"https://api-service.sperp.myhuaweicloud.com/6160/SparkPackERPs/v1/$metadata#SparkPackERPSessions/@Element",
"SessionId": "ac79876e-1e72-11ed-8000-000c299130e0",
"Version": "1000190",
"SessionTimeout": 30
}
（2）失败样例
{
"error": {
"code": 100000027,
"message": {
"lang": "en-us",
"value": "Login failed"
}
}
}
- 草稿单查询（Drafts）
接口地址
/id/SparkPackERPs/v1/Drafts
接口API功能描述
查询草稿单信息
调用方式
Get
可涵盖范围
采购申请（ID: 1470000113）、库存转储-报废单(ID:67)、库存发货-盘亏单(ID:59)、库存收货-盘盈单(ID:60)等
请求地址参数
参数名称
参数说明
地址示例
()
在地址中加入(单据内部标识)返回指定单据
/id/SparkPackERPs/v1/Drafts(1)
filter
筛选条件：“$filter=DocObjectCode eq '各单据ID'”
/id/SparkPackERPs/v1/Drafts?$filter=DocObjectCode eq '1470000113'
select
返回参数筛选，不包括在值中的单据头参数将不会返回，无法限制行明细参数
/id/SparkPackERPs/v1/ Drafts?$select=DocEntry,DocDate, DocumentLines
请求头参数
参数名称
参数说明
Cookie
登录时获取的sessionid，值格式为“SparkPackERPSESSION=获取的sessionid”
返回参数(详细字段见Excel字段清单)
参数名称
上级参数
参数描述
参数类型
参数说明
value
返回值
List
指定单张时无此层级
DocEntry
value
单据内部标识
Int
单据内部唯一标识
RequriedDate
value
必需日期
String
格式为"2022-08-23T00:00:00Z"
Requester
value
申请人代码
String
申请用户编码
RequesterName
value
申请人名称
String
申请用户名称
RequesterDepartment
value
部门代码
Int
DocumentLines
value
行明细
List
LineNum
DocumentLines
行号
Int
ItemCode
DocumentLines
物料代码
String
ItemDescription
DocumentLines
物料描述
String
Quantity
DocumentLines
数量
Double
Price
DocumentLines
价格
Double
返回样例
{
"value": [
{
"DocEntry": 16,
"RequriedDate": "2022-08-23T00:00:00Z",
"Requester": "A001",
"RequesterName": "销售经理：张涛",
"DocumentLines": [
{
"LineNum": 0,
"ItemCode": "11028",
"ItemDescription": "聚氯乙烯",
"Quantity": 55.0,
"Price": 300.0,
},
{
"LineNum": 1,
"ItemCode": "14003",
"ItemDescription": "聚丙烯",
"Quantity": 11.0,
"ShipDate": null,
"Price": 33.0
}
]
},
{
"DocEntry": 17,
"RequriedDate": "2022-08-23T00:00:00Z",
"Requester": "A002",
"RequesterName": "销售经理：王五",
"DocumentLines": [
{
"LineNum": 0,
"ItemCode": "11028",
"ItemDescription": "聚氯乙烯",
"Quantity": 55.0,
"Price": 300.0,
},
{
"LineNum": 1,
"ItemCode": "14003",
"ItemDescription": "聚丙烯",
"Quantity": 11.0,
"ShipDate": null,
"Price": 33.0
}
]
}
]
}
- 草稿单修改（Drafts）
接口地址
/id/SparkPackERPs/v1/Drafts
接口API功能描述
修改草稿单信息
调用方式
Patch
可涵盖范围
采购申请（ID: 1470000113）、库存转储-报废单(ID:67)、库存发货-盘亏单(ID:59)、库存收货-盘盈单(ID:60)等
请求地址参数
参数名称
参数说明
地址示例
()
在地址中加入(单据内部标识)返回指定单据
/id/SparkPackERPs/v1/Drafts(1)
请求头参数
参数名称
参数说明
Cookie
登录时获取的sessionid，值格式为“SparkPackERPSESSION=获取的sessionid”
- 审批流查询（ApprovalRequests）
接口地址
/id/SparkPackERPs/v1/ ApprovalRequests
接口API功能描述
查询审批流信息
调用方式
Get
请求地址参数
参数名称
参数说明
地址示例
()
在地址中加入(审批流唯一标识-Code)返回指定单据
/id/SparkPackERPs/v1/ApprovalRequests (1)
filter
筛选条件，采购申请的条件值为“$filter=ObjectType
eq '1470000113'”
/id/SparkPackERPs/v1/ ApprovalRequests?$filter=ObjectType
eq '1470000113'
select
返回参数筛选，不包括在值中的单据头参数将不会返回，无法限制行明细参数
/id/SparkPackERPs/v1/ ApprovalRequests?$select=Code,Status
请求头参数
参数名称
参数说明
Cookie
登录时获取的sessionid，值格式为“SparkPackERPSESSION=获取的sessionid”
返回参数
参数名称
上级参数
参数描述
参数类型
参数说明
value
返回值
List
指定单张时无此层级
Code
value
审批流唯一标识
Int
唯一标识
DraftEntry
value
关联的草稿标识
Int
关联草稿唯一标识
Status
value
审批状态
String
arsPending-未决
arSparkPackERPproved-通过
arsNotApproved-驳回
Remarks
value
备注
String
返回样例：
{
"value": [
{
"Code": 17,
"ObjectType": "1470000113",
"Status": "arSparkPackERPproved",
"Remarks": null,
"DraftEntry": 16
},{
"Code": 18,
"ObjectType": "1470000113",
"Status": "arSparkPackERPproved",
"Remarks": null,
"DraftEntry": 17
}
]
}
- 草稿单审批（ApprovalRequests）
接口地址
/id/SparkPackERPs/v1/ApprovalRequests(x)
接口API功能描述
发送审批流审批结果
调用方式
patch
请求地址参数
参数名称
参数说明
地址示例
()
在地址中加入(审批流唯一标识-Code)审批指定单据
/id/SparkPackERPs/v1/ApprovalRequests (1)
请求头参数
参数名称
参数说明
Cookie
登录时获取的sessionid，值格式为“SparkPackERPSESSION=获取的sessionid”
请求体参数
参数名称
上级参数
参数描述
参数类型
参数说明
ApprovalRequestDecisions
审批决定
List
Status
ApprovalRequestDecisions
审批状态
String
arsPending-未决
arSparkPackERPproved-通过
arsNotApproved-驳回
Remarks
ApprovalRequestDecisions
备注
String
请求样例：
{
"ApprovalRequestDecisions": [
{
"Remarks":"Approved",
"Status":"ardApproved"
}
]
}
返回参数
参数名称
上级参数
参数描述
参数类型
参数说明
error
失败信息
List
失败时返回，成功返回空值
code
error
错误代码
Int
SparkPackERP错误代码，失败时返回
message
error
错误信息
List
失败时返回
value
message
错误详情
String
SparkPackERP错误消息，失败时返回
返回样例：
{
"error": {
"code": 206,
"message": {
"lang": "en-us",
"value": "Bad patch content."
}
}
}
- 单据查询（{objType}）
接口地址
/id/SparkPackERPs/v1/{objType}
接口API功能描述
查询单据信息，可以由实施人员配置选择哪种单据
调用方式
Get
可涵盖范围
采购申请（ID: 1470000113）、库存转储-报废单(ID:67)、库存发货-盘亏单(ID:59)、库存收货-盘盈单(ID:60)等
请求地址参数
参数名称
参数说明
地址示例
{objType} ()
在地址中加入单据类型(单据内部标识)返回指定单据
/id/SparkPackERPs/v1/PurchaseRequests (1)
filter
筛选条件：“$filter= U_SyncStatus eq 'N'”
/id/SparkPackERPs/v1/PurchaseRequests?$filter=U_SyncStatus eq 'N'
select
返回参数筛选，不包括在值中的单据头参数将不会返回，无法限制行明细参数
/id/SparkPackERPs/v1/PurchaseRequests?$select=DocEntry,DocDate, DocumentLines
请求头参数
参数名称
参数说明
Cookie
登录时获取的sessionid，值格式为“SparkPackERPSESSION=获取的sessionid”
返回参数(详细字段见Excel字段清单)
参数名称
上级参数
参数描述
参数类型
参数说明
value
返回值
List
指定单张时无此层级
DocEntry
value
单据内部标识
Int
单据内部唯一标识
RequriedDate
value
必需日期
String
格式为"2022-08-23T00:00:00Z"
Requester
value
申请人代码
String
申请用户编码
RequesterName
value
申请人名称
String
申请用户名称
RequesterDepartment
value
部门代码
Int
DocumentLines
value
行明细
List
LineNum
DocumentLines
行号
Int
ItemCode
DocumentLines
物料代码
String
ItemDescription
DocumentLines
物料描述
String
Quantity
DocumentLines
数量
Double
Price
DocumentLines
价格
Double
返回样例
{
"value": [
{
"DocEntry": 16,
"RequriedDate": "2022-08-23T00:00:00Z",
"Requester": "A001",
"RequesterName": "销售经理：张涛",
"DocumentLines": [
{
"LineNum": 0,
"ItemCode": "11028",
"ItemDescription": "聚氯乙烯",
"Quantity": 55.0,
"Price": 300.0,
},
{
"LineNum": 1,
"ItemCode": "14003",
"ItemDescription": "聚丙烯",
"Quantity": 11.0,
"ShipDate": null,
"Price": 33.0
}
]
},
{
"DocEntry": 17,
"RequriedDate": "2022-08-23T00:00:00Z",
"Requester": "A002",
"RequesterName": "销售经理：王五",
"DocumentLines": [
{
"LineNum": 0,
"ItemCode": "11028",
"ItemDescription": "聚氯乙烯",
"Quantity": 55.0,
"Price": 300.0,
},
{
"LineNum": 1,
"ItemCode": "14003",
"ItemDescription": "聚丙烯",
"Quantity": 11.0,
"ShipDate": null,
"Price": 33.0
}
]
}
]
}
- 单据修改（{objType}）
接口地址
/id/SparkPackERPs/v1/{objType}
接口API功能描述
修改单据信息
调用方式
Patch
可涵盖范围
采购申请（ID: 1470000113）、库存转储-报废单(ID:67)、库存发货-盘亏单(ID:59)、库存收货-盘盈单(ID:60)等
请求地址参数
参数名称
参数说明
地址示例
{objType} ()
在地址中加入(单据内部标识)返回指定单据
/id/SparkPackERPs/v1/PurchaseRequests (1)
请求头参数
参数名称
参数说明
Cookie
登录时获取的sessionid，值格式为“SparkPackERPSESSION=获取的sessionid”
- 查询用户信息（Users）
接口地址
/id/SparkPackERPs/v1/ Users
接口API功能描述
查询用户的详细信息
调用方式
Get
请求地址参数
参数名称
参数说明
地址示例
()
在地址中加入(用户标识)返回指定用户
/id/SparkPackERPs/v1/ Users (1)
请求头参数
参数名称
参数说明
Cookie
登录时获取的sessionid，值格式为“SparkPackERPSESSION=获取的sessionid”
