预算管理

简介:预算管理

HOST:localhost:8161

联系人:admin

Version:1.0.0

接口路径:/v2/api-docs?group=1.0.0

[TOC]

余额查询接口 | BPM

预算部门余额查询

接口地址:/open/budget/dept/balance

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "deptCode": "",
  "subjectCode": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ao	ao	body	true	部门预算余额查询入参	部门预算余额查询入参
deptCode	部门编码		true	string
subjectCode	科目编码		true	string

响应状态:

状态码	说明	schema
200	OK	部门余额出参
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
budgetAvailableBalanceAmount	预算可用余额	number
controlCycleCode	控制周期编码(1、月度 2、季度 3、年度)	integer(int32)	integer(int32)
controlCycleDesc	预算周期描述,2022年10月/2022年Q3/2022年	string
controlCycleName	控制周期名称	string
controlStrategyCode	预算控制策略编码(1超预算禁止,2超预算提醒,3超预算审批)	integer(int32)	integer(int32)
controlStrategyName	预算控制策略编码名称	string
deptCode	部门编码	string
subjectCode	科目编码	string

响应示例:

{
	"budgetAvailableBalanceAmount": 0,
	"controlCycleCode": 0,
	"controlCycleDesc": "",
	"controlCycleName": "",
	"controlStrategyCode": 0,
	"controlStrategyName": "",
	"deptCode": "",
	"subjectCode": ""
}

预算项目余额查询

接口地址:/open/budget/project/balance

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "projectCode": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ao	ao	body	true	项目预算余额查询入参	项目预算余额查询入参
projectCode	项目编码		true	string

响应状态:

状态码	说明	schema
200	OK	项目余额出参
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
availableBalanceAmount	项目预算余额	number
controlStrategyCode	项目控制策略编码	integer(int32)	integer(int32)
controlStrategyName	项目控制策略名称	string
projectCode	项目编码	string

响应示例:

{
	"availableBalanceAmount": 0,
	"controlStrategyCode": 0,
	"controlStrategyName": "",
	"projectCode": ""
}

资金计划余额查询

接口地址:/open/fundsplan/dept/balance

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "deptCode": "",
  "queryDate": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
fundPlanBalanceQueryAO	fundPlanBalanceQueryAO	body	true	查询资金计划余额入参	查询资金计划余额入参
deptCode	传递预算管理二级或三级部门编码即可,由预算管理系统解析为资金计划的末级部门编码		false	string
queryDate	查询日期 申请及审批节点：预计付款日期 出纳审批/付款节点：当前日期		false	string(date-time)

响应状态:

状态码	说明	schema
200	OK	HttpResult«查询资金计划余额出参»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		查询资金计划余额出参	查询资金计划余额出参
onTheWayAmount	在途金额	number
plannedAmount	计划金额	number
message		string

响应示例:

{
	"code": 0,
	"data": {
		"onTheWayAmount": 0,
		"plannedAmount": 0
	},
	"message": ""
}

控制接口 | BPM

付款申请

接口地址:/open/paymentApplication

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

付款申请

请求示例:

{
  "billNo": "",
  "bpmProcessCode": "",
  "contractFinish": 0,
  "contractNo": "",
  "createUserId": "",
  "createUserName": "",
  "deptCode": "",
  "executeTime": "",
  "mainContractNo": "",
  "paymentAmount": 0,
  "paymentNode": 0,
  "processType": 0,
  "projectCode": "",
  "releaseAmount": 0,
  "subjectCode": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ao	ao	body	true	付款申请入参_1	付款申请入参_1
billNo	单据号		false	string
bpmProcessCode	流程单号		true	string
contractFinish	合同是否完结 1完结 0未完结		false	integer(int32)
contractNo	合同编码(传递飞书合同的合同ID, 飞书那边的contract_id字段)		true	string
createUserId	申请人id		false	string
createUserName	申请人名称		false	string
deptCode	部门编码		true	string
executeTime	执行时间（发起时间 或 审核时间 或 付款时间）		true	string(date-time)
mainContractNo	主合同ID(传递飞书合同的合同组ID字段 飞书那边的group_id字段)		true	string
paymentAmount	付款金额		true	number
paymentNode	付款节点 1、付款申请提交(付款之前调用) 2、付款申请审批不通过(仅在审核不通过之后调用) 3、付款成功(出纳付款之后回调)		true	integer(int32)
processType	流程类型 1 项目+合同预算流程 2 合同预算流程----有部门，无项目 3 项目付款流程----付款申请有关联项目 4 付款流程-----付款申请未关联项目，且未关联合同 对接BPM时,BPM可不传,由预算根据项目/科目/部门编码是否传递来解析,但是这个字段预留		true	integer(int32)
projectCode	项目编码		true	string
releaseAmount	需要释放的金额(即无需履约的金额)		false	number
subjectCode	科目编码		true	string

响应状态:

状态码	说明	schema
200	OK	HttpResult«付款申请入参»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		付款申请入参	付款申请入参
message	执行结果的消息描述	string
result	执行结果	boolean
message		string

响应示例:

{
	"code": 0,
	"data": {
		"message": "",
		"result": true
	},
	"message": ""
}

立项及预算调整

接口地址:/open/projectInitiationAndBudgetAdjustment

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

立项及预算调整

请求示例:

{
  "approvalResults": 0,
  "bpmProcessCode": "",
  "createUserId": "",
  "createUserName": "",
  "sceneNode": 0
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ao	ao	body	true	审批回调接口入参	审批回调接口入参
approvalResults	审核结果：1、成功 2、失败		true	integer(int32)
bpmProcessCode	流程单号		true	string
createUserId	申请人id		false	string
createUserName	申请人名称		false	string
sceneNode	执行场景：1、部门预算调整(调增调减)审批 2、部门预算调拨审批 3、项目立项发起审批 4、项目预算调整(调增调减)审批		true	integer(int32)

响应状态:

状态码	说明	schema
200	OK	HttpResult«审批回调接口出参»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		审批回调接口出参	审批回调接口出参
message		string

响应示例:

{
	"code": 0,
	"data": {},
	"message": ""
}

查询接口 | BPM

预算部门列表查询

接口地址:/open/budget/dept/list

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "deptCode": "",
  "deptName": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ao	ao	body	true	BpmQueryBudgetDeptAO	BpmQueryBudgetDeptAO
deptCode	项目部门		false	string
deptName	项目名称		false	string

响应状态:

状态码	说明	schema
200	OK	部门查询出参_1
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
item		array	部门查询出参
fsDeptCode	飞书部门编码	string
fsDeptName	飞书部门名称	string
label	预算末级部门名称	string
value	预算末级部门编码	string

响应示例:

{
	"item": [
		{
			"fsDeptCode": "",
			"fsDeptName": "",
			"label": "",
			"value": ""
		}
	]
}

预算项目列表查询

接口地址:/open/budget/project/list

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "deptCode": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ao	ao	body	true	预算项目列表查询入参	预算项目列表查询入参
deptCode	项目部门		false	string

响应状态:

状态码	说明	schema
200	OK	项目查询出参_1
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
item		array	项目查询出参
label	部门名称	string
value	部门编码	string

响应示例:

{
	"item": [
		{
			"label": "",
			"value": ""
		}
	]
}

预算科目列表查询

接口地址:/open/budget/subject/list

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "contractId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
ao	ao	body	true	预算科目列表查询入参	预算科目列表查询入参
contractId	合同ID		false	string

响应状态:

状态码	说明	schema
200	OK	项目查询出参_2
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
item		array	预算科目列表查询出参
label	预算科目名称	string
value	预算科目编码	string

响应示例:

{
	"item": [
		{
			"label": "",
			"value": ""
		}
	]
}