预算控制（Open API）接口使用说明
1.1 应用场景
预算控制支持了一些常见业务场景，但是并未支持一些特殊控制场景，遇到特殊控制场景时，需要各项目组自行调用预算扣减接口实现。
外部API接口主要用于苍穹以外第三方系统调用的接口。
1.2 接口调用过程
预算
1.3 接口说明
1.3.1 预算查询使用属性服务接口（BudgetQueryPropertyApiService）
| 接口名称 | 单据属性查询接口（BudgetQueryPropertyApiService） |
| 入口参数 | Bostype：单据类型（String） |
| 返回结果 | ApiResult.success： true-接口调用成功， false，接口调用出错； |
ApiResult.data： 接口调用成功时，为接口正常返回的数据（预算扣减所使用的单据属性列表-Collection<String> ）， 接口调用失败时：为空； | |
ApiResult.message： 接口调用成功时，无内容， 调用失败，出错内容信息，如“传入字段为空”； | |
ApiResult.errorCode： success，接口正常返回， fail，接口调用异常 |
接口返回结果字段说明示例（费用报销单为例）
| currency.name | 币别名称 |
| applier.number | 申请人编码 |
| modifytime | 修改时间 |
| expenseentryentity.expenseitem.number | 分录费用项目编码 |
| expenseentryentity.expenseamount | 分录的费用账号 |
| costdept.name | 费用承担部门名称 |
| costcompany.number | 费用承担公司编码 |
| expenseentryentity.expenseitem.name | 分录费用项目名称 |
| org.number | 组织编码 |
| number | 单据编码 |
| org.name | 组织名称 |
| bizdate | 费用发生日期 |
| currency.number | 币别编码 |
| costdept.number | 费用承担部门编码 |
| company.name | 公司名称 |
| id | 单据id |
| company.number | 公司编码 |
| costcompany.name | 费用承担公司名称 |
| applier.name | 申请人名称 |
1.3.2 预算扣减服务接口
| 接口名称 | 占用服务接口（BudgetOccupyApiService） |
| 执行服务接口（BudgetExcuteApiService） | |
| 入口参数 | Map<String, Object> params |
参数说明 | 预算控制接口需要使用的业务单据属性（根据BudgetQueryPropertyApiService接口的返回属性值来提供参数） |
| bostype:单据类型 | |
| id:单据id | |
| number/billno:单据编码 | |
预算维度组合对应单据组织科目等信息，以BudgetQueryPropertyApiService接口返回的字段为主 | |
| 返回结果及说明 | |
| ApiResult.success | True：预算控制通过 |
| False：预算控制不通过 | |
| ApiResult.data | DONTCONTROL：不控制 |
| PASS：通过（未超预算） | |
| BYOND：预算控制不通过（超预算） | |
| ApiResult.message | 接口调用成功时，无内容 |
| 调用失败时，出错内容信息，如“传入字段为空” | |
| ApiResult.errorCode | success:接口正常返回 |
| fail:接口调用异常 | |
注意：
外部单据控制仅支持执行冲销上游占用数场景，需要在执行时候制定需要冲销的上游的单据的ID及冲销金额，具体参数说明如下：
2. 针对不同场景下，依据传入的业务信息匹配不同预算指标进行预算管控的场景，可以使用匹配规则条件设置多个匹配规则。需要在控制单据注册中将对应条件字段注册到预算控制模型中，并在匹配规则条件中运用该条件，方法与星瀚内部单据控制使用条件相同。具体惨参照预算控制-维度匹配规则操作说明。
接着在调用预算接口时候，将条件字段信息与其他业务信息一并在接口中传入即可，建议在第一条分录中传入，若多条分录中都包含条件字段，则随机取一条分录中的条件信息。
1.3.3预算返还服务接口
| 接口名称 | 关闭服务接口（BudgetCloseApiService） |
| 删除服务接口（BudgetReturnApiService） | |
| 入口参数 | Map<String, Object> |
参数说明 | id：业务单据id |
| billtype：业务单据类型 | |
| 返回结果 | 结果说明 |
| ApiResult.success | True：预算扣减记录删除成功 |
| False：预算扣减记录删除失败 | |
| ApiResult.data | SUCCESS：预算扣减记录删除成功 |
| FAIL：预算扣减记录删除失败 | |
| ApiResult.message | 接口调用成功时，无内容 |
| 调用失败时，出错内容信息，如“传入字段为空” | |
| ApiResult.errorCode | success:接口正常返回 |
| fail:接口调用异常 |
变更记录
| 产品版本 | 更新内容 | 更新日期 |
| V6.0.8 | 初始版本 | 2024年3月 |
预算控制（Open API）接口使用说明
本文2024-09-22 23:07:51发表“云星瀚知识”栏目。
本文链接：https://wenku.my7c.com/article/kingdee-xinghan-131064.html
