budget/check
目录 |
1.接口说明
1.1接口描述
预算控制
1.2适用版本
支持U8V12.0 及更高版本
2.使用场景
预算控制应用
3.接口调用说明
3.1请求说明
| url | https://api.yonyouup.com/api/budget/check |
| 格式 | JSON |
| https请求方式 | POST |
| 编码类型 | UTF-8 |
3.2url参数说明
| 参数 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| from_account | string | 是 | 调用方id |
| to_account | string | 是 | 提供方id |
| app_key | string | 是 | 应用编码 |
| token | string | 是 | api调用唯一识别码 |
| ds_sequence | number | 否 | 数据源序号（默认取应用的第一个数据源） |
3.3请求体参数说明
| 参数 | 类型 | 参数路径 | 是否必填 | 描述 |
|---|---|---|---|---|
| SysID | string | 是 | 来源系统ID | |
| SysName | string | 是 | 来源系统名称 | |
| VoucherID | string | 是 | 单据编号号 | |
| VoucherType | string | 是 | 单据类型 | |
| VoucherCode | string | 是 | 单据编号 | |
| VoucherDate | date | 是 | 单据日期 | |
| BudgetFactAddDate | date | 否 | 预算扣减日期，如果不填值，默认使用VoucherDate作为扣减日期 | |
| VoucherUpdateDate | date | 是 | 单据修改日期 | |
| BudgetFactAdd | string | 是 | 同一张单据预算扣减标志 (True:扣减预算 False:回冲预算) | |
| RowNum | number | VoucherEntrys | 否 | 行号 |
| cDeptID | string | VoucherEntrys | 否 | 部门编码 |
| cDeptName | string | VoucherEntrys | 否 | 部门名称 |
| cItemID | string | VoucherEntrys | 否 | 项目编码 |
| cItemName | string | VoucherEntrys | 否 | 项目名称 |
| Digest | string | VoucherEntrys | 是 | 摘要 |
| fMoney | string | VoucherEntrys | 是 | 单据金额 |
| cVchMaker | string | VoucherEntrys | 是 | 制单人 |
| IsCtrl | number | VoucherEntrys | 是 | 是否需要预算控制 1:控制 0:不控制 |
| BudgetCode | string | VoucherEntrys | 否 | 预算编码 |
| DepCode | string | VoucherEntrys | 否 | 部门编码 |
| ItemClass | string | VoucherEntrys | 否 | 项目大类 |
| ItemCode | string | VoucherEntrys | 否 | 项目编码 |
| fBillFactValue | number | VoucherEntrys | 是 | 实际数（可为0） |
| fBillReserveValue | number | VoucherEntrys | 是 | 占用数（可为0） |
3.4请求示例
POST https://api.yonyouup.com/api/budget/check?from_account=openapi_dev&to_account=openapi_ent&app_key=opa6fdd4bea98b95ad7&token=843d03f66e6544e19707ccec11030296&ds_sequence=1
POST 内容：
{
"budget":{
"SysID":"FC",
"SysName":"U费控",
"VoucherID":"002444",
"VoucherType":"报销通讯费",
"VoucherCode":"0000123",
"VoucherDate":"2014-9-12",
"BudgetFactAddDate":null,
"VoucherUpdateDate":"2014-9-1209:20:08",
"BudgetFactAdd":true,
"VoucherEntrys":[
{
"RowNum":"3",
"cDeptID":"009",
"cDeptName":"财务部",
"cItemID":"",
"cItemName":"现金流量",
"Digest":"广东出差",
"fMoney":"2888.24",
"cVchMaker":"demo",
"IsCtrl":"1",
"BudgetCode":"0001",
"DepCode":"",
"ItemClass":"01",
"ItemCode":"010101",
"fBillFactValue":"1888888888.00",
"fBillReserveValue":"199.20"
}
]
}
}
3.5返回参数说明
| 参数说明 | 类型 | 参数路径 | 描述 |
|---|---|---|---|
| errcode | string | 错误码，0 为正常。 | |
| errmsg | string | 错误信息。 | |
| ControlResult | number | 预算结果（-1：预算通过 0：严格控制，预算没有通过 2：提示预算已经超过，允许单据继续处理） | |
| ControlResultInfo | string | 描述原因 | |
| cBgItemCode | string | OverBudgetDataRows | 预算项目编码 |
| cBgItemName | string | OverBudgetDataRows | 预算项目名称 |
| cDepCode | string | OverBudgetDataRows | 部门编码 |
| cDepName | string | OverBudgetDataRows | 部门名称 |
| cItemCode | string | OverBudgetDataRows | 项目名称 |
| cItemName | string | OverBudgetDataRows | 项目名称 |
| cArchGroupName | string | OverBudgetDataRows | 控制范围组名 |
| Target | string | OverBudgetDataRows | 指标 |
| Period | string | OverBudgetDataRows | 周期 |
| BudgetValue | number | OverBudgetDataRows | 预算数 |
| FactValue | number | OverBudgetDataRows | 实际数 |
| ReserveValue | number | OverBudgetDataRows | 占用数 |
| CanUsedValue | number | OverBudgetDataRows | 可用预算 |
| frate | number | OverBudgetDataRows | 控制数 |
| VoucherChildValue | number | OverBudgetDataRows | 本单金额 |
| DiffOfBudgetAndFact | number | OverBudgetDataRows | 预算数差异（预算数-实际数-占用数） |
| OverCtrlValue | number | OverBudgetDataRows | 控制数差异（控制数-实际数-占用数 |
| OverCtrlRate | number | OverBudgetDataRows | 实际完成率(%) |
3.6正确返回示例
JSON示例:
{
"ControlResult":2,
"ControlResultInfo":"当前单据超预算；实际完成率(%)是38071.15!",
"OverBudgetDataRows":[
{
"cBgItemCode":"0001",
"cBgItemName":"基本支出",
"cDepCode":"",
"cDepName":"",
"cItemCode":"010101",
"cItemName":"播音主持艺术学院-运行经费",
"cArchGroupName":"",
"Target":"累计发生",
"Period":"2014年",
"BudgetValue":"4964690.96",
"FactValue":"1226056.38",
"ReserveValue":"0.00",
"CanUsedValue":"3738634.58",
"frate":"2482345.48",
"VoucherChildValue":"1888888888.00",
"DiffOfBudgetAndFact":"-1885150452.62",
"OverCtrlValue":"-1887632798.10",
"OverCtrlRate":"38071.15"
}
]
}
3.7错误返回示例
application/json;charset=UTF-8
{
"errcode" : "30021",
"errmsg" : "此应用未上线"
}