预算信息查询接口
查询预算接口说明
该接口用于查询预算的信息，其中包含预算单元中的占用金额，冻结金额，预算金额，可用金额（包含结转），以及预算计划信息。
接口地址
/api/openapi/budget
请求类型
POST
请求参数
请求参数示例
{
"orgBizCode": "预算组织编码001",
"subjectBizCode": "预算科目编码001"
}
请求参数说明
| 字段 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| orgBizCode | string | 必填其一 | 预算组织编码 |
| subjectBizCode | string | 必填其一 | 预算科目编码 |
响应参数
响应参数示例
{
"code": "ACK",
"message": null,
"data": {
"budgetPlans": [
{
"bizCode": "预算方案编码",
"code": "预算方案内码",
"name": "预算方案名称",
"startDay": "20190101",
"endDay": "20191231",
"currency": "CNY",
"compilationDimension": "MONTHLY",
"enabled": true,
"budgets": [
{
"code": "CODE001",
"subjectBizCode": "科目编码001",
"subjectName": "科目名称",
"orgBizCode": "组织编码001",
"orgName": "组织名称",
"endDay": 20221001,
"startDay": 20220601,
"carryOver": false,
"controlDimension": "MONTHLY",
"compilationDimension": "MONTHLY",
"weakControl": false,
"weakControlPercent": 100,
"warn": false,
"warnThresholdPercent": 100,
"forbid": true,
"forbidPercent": 100,
"budgetUnits": [
{
"code": "CODE001",
"startDay": "20190101",
"endDay": "20190131",
"periodNum": 1,
"budgetAmount": 100.00,
"freezeAmount": 30.00,
"occupyAmount": 20.00,
"usableAmount": 50.00,
"carryOverUsableAmount": 600.0
}
]
}
]
}
]
}
}
响应参数说明
budgetPlans
| 字段 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| bizCode | string | 是 | 预算方案编码（外码） |
| code | string | 是 | 预算方案内码 |
| name | string | 是 | 预算方案名称 |
| startDay | string | 是 | 预算方案的开始时间 |
| endDay | string | 是 | 预算方案的结束时间 |
| currency | string | 是 | 币种 |
| compilationDimension | string | 是 | 预算编制周期: 月度 MONTHLY 季度 QUARTERLY 半年度 HALFYEARLY 年度 YEARLY 起止日期整段为一期（全段） INTACT |
| enabled | Boolean | 是 | 是否启用 |
| budgets | List<budgetDto> | 是 | 预算行信息 |
budgetDto预算行信息
- 以下取值当平级预算的预算方案的“预算控制”项设置为“预算行各自控制”时，取值为预算行上的信息，否则为预算方案上的信息：startDay、endDay、carryOver、controlDimension、compilationDimension、weakControl、weakControlPercent、forbid、forbidPercent
| 字段 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| code | string | 是 | 预算行编码,唯一标识 |
| subjectBizCode | string | 是 | 预算科目编码 |
| subjectName | string | 是 | 预算科目名称 |
| orgBizCode | string | 是 | 预算组织编码 |
| orgName | string | 是 | 预算组织名称 |
| endDay | string | 是 | 预算编制结束日期 |
| startDay | string | 是 | 预算编制开始日期 |
| carryOver | Boolean | 是 | 是否结转 |
| controlDimension | string | 是 | 控制方式： 月度 MONTHLY 季度 QUARTERLY 半年度 HALFYEARLY 年度 YEARLY 起止日期整段为一期（全段） INTACT |
| compilationDimension | string | 是 | 编制方式： 月度 MONTHLY 季度 QUARTERLY 半年度 HALFYEARLY 年度 YEARLY 起止日期整段为一期（全段） INTACT |
| weakControl | Boolean | 是 | 是否弱控 |
| weakControlPercent | BigDecimal | 是 | 弱控百分比 |
| forbid | Boolean | 是 | 是否强控 |
| forbidPercent | BigDecimal | 是 | 强控百分比 |
| budgetUnits | List<budgetUnitsDto> | 是 | 预算单元信息 |
budgetUnitsDto预算单元信息
| 字段 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| code | string | 是 | 预算单元编码，唯一标识 |
| startDay | string | 是 | 预算单元的开始时间 |
| endDay | string | 是 | 预算单元的结束时间 |
| periodNum | BigDecimal | 是 | 期号 |
| budgetAmount | BigDecimal | 是 | 预算金额 |
| freezeAmount | BigDecimal | 是 | 冻结金额 |
| occupyAmount | BigDecimal | 是 | 占用金额 |
| usableAmount | BigDecimal | 是 | 可用余额（usableAmount=budgetAmount-freezeAmount-occupyAmount） |
| carryOverUsableAmount | BigDecimal | 是 | 可用余额包含结转（carryOverUsableAmount=budgetAmount+结转额-freezeAmount-occupyAmount） |
修改记录
2022-07-07：预算查询接口，新增预算下放的配置信息，7-2迭代，待发布
2023-04-23：openapi文档迁移