Spendia开放接口

预算余额查询

接口描述

此接口用于查询预算余额数据

请求URI

/api/openapi/budget/balance/query

请求方式

POST

请求体示例

{
  "setOfBooksCode": "DEFAULT_SOB",
  "budgetOrganizationCode": "1001",
  "budgetVersionCode": "b001",
  "budgetStructureCode": "month",
  "budgetScenarioCode": "c001",
  "budgetPeriodYear": "2024",
  "budgetPeriodSemiannual": "",
  "quarterFrom": "",
  "quarterTo": "",
  "periodFrom": "2023-1",
  "periodTo": "2023-12",
  "periodSummaryFlag": "Y",
  "balanceQueryLineDTOS": [
    {
      "parameterType": "1003",
      "parameterValueList": ["f001"],
      "costCenterCode": "",
      "isAll": "N"
    },
    {
      "parameterType": "1005",
      "parameterValueList": [],
      "costCenterCode": "PROJECT",
      "isAll": "Y"
    }
  ]
}

请求体字段

字段名 类型 必填 主键 约束 说明
setOfBooksCode String ○ 账套编码
budgetOrganizationCode String ○ 预算组织编码
budgetVersionCode String ○ 预算版本编码
budgetStructureCode String ○ 预算表编码
budgetScenarioCode String ○ 预算场景编码
budgetPeriodYear String ▲ 日期格式：YYYY
当前预算表为年度时，必填		 年度
budgetPeriodSemiannual String ▲ 日期格式：YYYY-H1
当前预算表为半年度时，必填		 半年度
quarterFrom String ▲ 日期格式：YYYY-1Q
当前预算表为季度时，必填		 季度从
quarterTo String ▲ 日期格式：YYYY-2Q
当前预算表为季度时，必填		 季度到
periodFrom String ▲ 日期格式：会计期间里定义的期间名（例：2024-1）
当前预算表为月度时，必填		 期间从
periodTo String ▲ 日期格式：会计期间里定义的期间名（例：2024-2）
当前预算表为月度时，必填		 期间到
periodSummaryFlag String ○ Y：汇总
N：不汇总		 期段汇总
balanceQueryLineDTOS Array ○ 预算纬度查询条件

balanceQueryLineDTOS

字段名 类型 必填 主键 约束 说明
parameterType String ○ 1001：预算项目类型
1002：预算项目组
1003：预算项目
1004：币种（未对应）
1005：成本中心		 预算维度类型
parameterValueList String ▲ isAll=!Y时，必填 预算维度值、isAll=Y时，不校验
costCenterCode String 成本中心编码、预算维度类型为成本中心以外时不需要传值
isAll String Y：全部
N或者为空：手动选择		 是否全选

接口返回示例

[
  {
    "itemTypeName": null,
    "itemName": "默认项目",
    "itemGroupName": null,
    "periodYear": 2023,
    "periodSemiannual": null,
    "periodQuarter": null,
    "periodName": "2023-1~2023-12",
    "currency": "JPY",
    "bgtFunAmount": "0",
    "expReserveFunAmount": "0",
    "expUsedFunAmount": "577568",
    "expAvailableFunAmount": "-577568",
    "dimension1Name": "テスト用項目",
    "dimension2Name": null,
    "dimension3Name": null,
    "dimension4Name": null,
    "dimension5Name": null,
    "dimension6Name": null,
    "dimension7Name": null,
    "dimension8Name": null,
    "dimension9Name": null,
    "dimension10Name": null,
    "dimension11Name": null,
    "dimension12Name": null,
    "dimension13Name": null,
    "dimension14Name": null,
    "dimension15Name": null,
    "dimension16Name": null,
    "dimension17Name": null,
    "dimension18Name": null,
    "dimension19Name": null,
    "dimension20Name": null
  },
  {
    "itemTypeName": null,
    "itemName": "默认项目",
    "itemGroupName": null,
    "periodYear": 2023,
    "periodSemiannual": null,
    "periodQuarter": null,
    "periodName": "2023-1~2023-12",
    "currency": "JPY",
    "bgtFunAmount": "0",
    "expReserveFunAmount": "0",
    "expUsedFunAmount": "700",
    "expAvailableFunAmount": "-700",
    "dimension1Name": "123",
    "dimension2Name": null,
    "dimension3Name": null,
    "dimension4Name": null,
    "dimension5Name": null,
    "dimension6Name": null,
    "dimension7Name": null,
    "dimension8Name": null,
    "dimension9Name": null,
    "dimension10Name": null,
    "dimension11Name": null,
    "dimension12Name": null,
    "dimension13Name": null,
    "dimension14Name": null,
    "dimension15Name": null,
    "dimension16Name": null,
    "dimension17Name": null,
    "dimension18Name": null,
    "dimension19Name": null,
    "dimension20Name": null
  }
]

接口返回字段

字段名称 类型 说明
itemTypeName String 预算项目类型
itemName String 预算项目
itemGroupName String 预算项目组
periodYear String 年度
periodSemiannual String 预算半年度
periodQuarter String 季度
periodName String 期间
currency String 币种
bgtFunAmount String 预算额
expReserveFunAmount String 保留额
expUsedFunAmount String 发生额
expAvailableFunAmount String 可用额
dimension1Name~dimension20Name String 成本中心项编码

失败示例

{
  "message": "参数:setOfBooksCode不存在",
  "errorCode": "spd.28016.004"
}

字段说明

字段名称 类型 说明
message String 返回信息说明
errorCode String 返回错误码

错误代码

errorCode message 说明
120003 缺少必填项:{0}
spd.28016.003 参数:{0},日期格式不正确
spd.28016.004 {0}不存在
spd.28016.005 {0}格式不正确
spd.28016.006 参数:{0}，请输入正确的日期范围
spd.29262.001 {0}和{1}的查询范围必须在同一年度
120001 当前操作需要租户权限
spd.29262.002 参数值:{0}不存在
spd.29262.003 成本中心:{0}不存在
spd.29262.004 成本中心项:{0}不存在
spd.28016.014 成本中心:{0}无效或不存在

←