文档中心
搜索
Ask AI
全部文档
文档中心开发者中心API 文档财务模型

财务模型

财务模型（FinancialModel / CUB）是 DeepFOS 平台的核心组件，用于存储和管理多维财务数据。

接口概览

财务模型对外文档重点覆盖以下能力：

  • 数据读写：批量查询或保存财务数据

  • 数据清理：清空指定范围的数据

  • 数据复制：在不同维度组合间复制数据

  • 权限控制：初始化和更新审批单元状态

  • 数据审计：查询数据变更日志

数据读写接口

财务模型数据查询

用于根据维度表达式和公共 POV 条件查询财务模型数据，适合按期间、主体、科目等维度组合读取明细或结果数据。

请求

项目

值

HTTP Method

POST

Path

https://xxxx.com/deepfos-server/financial-model-server1-0/cube-data/query

Request Body 字段

字段名

类型

必填

说明

示例

cubeName

String

是

财务模型名称

Ana_Cube

folderId

String

否

财务模型所在目录 ID

100

commonScript

String

否

公共筛选脚本

scenario{Actual}

script

String

是

查询脚本

year{2024}->entity{firm1}->account{Revenue}

Request Body 示例

Copy
{
  "cubeName": "Ana_Cube",
  "folderId": "100",
  "commonScript": "scenario{Actual}",
  "script": "year{2024}->entity{firm1}->account{Revenue}"
}

响应

响应体字段

字段名

类型

说明

data

Array

查询结果

data[].year

String

年度

data[].entity

String

主体

data[].account

String

科目

data[].data

Number

数据值

message

String

响应消息

code

Integer

响应码

status

Boolean

请求是否成功

响应示例

Copy
{
  "data": [
    {
      "year": "2024",
      "entity": "firm1",
      "account": "Revenue",
      "data": 1000000
    }
  ],
  "message": null,
  "code": 0,
  "status": true
}

电子表格数据保存

用于批量保存财务模型数据。同一维度组合没有数据则新增，有数据则修改。

请求

项目

值

HTTP Method

POST

Path

https://xxxx.com/deepfos-server/financial-model-server1-0/react/spreadsheet/save

Request Body 字段

字段名

类型

必填

说明

wbName

String

是

工作簿名称

wbFolderId

String

否

工作簿目录 ID

wbPath

String

否

工作簿路径

needCheck

Boolean

否

是否校验

dataAuditSwitch

Boolean

否

是否开启数据审计

sheetDatas

Array

是

待保存的表页数据

sheetDatas[].cubeName

String

是

财务模型名称

sheetDatas[].cubeFolderId

String

否

财务模型目录 ID

sheetDatas[].cubePath

String

否

财务模型路径

sheetDatas[].sheetId

String

是

表页 ID

sheetDatas[].commonMember

Object

否

公共维度成员

sheetDatas[].rowDatas

Array

是

行数据

Request Body 示例

Copy
{
  "wbName": "Budget2024",
  "wbFolderId": "100",
  "wbPath": "/demo",
  "needCheck": true,
  "dataAuditSwitch": true,
  "sheetDatas": [
    {
      "cubeName": "Ana_Cube",
      "cubeFolderId": "100",
      "cubePath": "/demo",
      "sheetId": "sheet_001",
      "commonMember": {
        "year": "2024",
        "scenario": "Actual"
      },
      "rowDatas": [
        {
          "entity": "firm1",
          "account": "Revenue",
          "data": 1000000
        }
      ]
    }
  ]
}

响应

响应体字段

字段名

类型

说明

status

Boolean

请求是否成功

code

Integer

响应码

message

String

响应消息

data

Array

各表页保存结果

data[].sheetId

String

表页 ID

data[].cubeName

String

财务模型名称

data[].commonErrorMsgList

Array

公共错误信息

响应示例

Copy
{
  "status": true,
  "code": 0,
  "message": null,
  "data": [
    {
      "sheetId": "sheet_001",
      "cubeName": "Ana_Cube",
      "commonErrorMsgList": []
    }
  ]
}

数据操作接口

清空数据

用于清空财务模型中指定维度组合的数据。

请求

项目

值

HTTP Method

POST

Path

https://xxxx.com/deepfos-server/financial-model-server1-0/cubeCalculate/sync/clearData

Request Body 字段

字段名

类型

必填

说明

cubeName

String

是

财务模型名称

cubeFolderId

String

否

财务模型目录 ID

cubePath

String

否

财务模型路径

pov

Object

是

清空范围

pov.year

String

否

年度

pov.scenario

String

否

场景

pov.entity

String

否

主体

Request Body 示例

Copy
{
  "cubeName": "Ana_Cube",
  "cubeFolderId": "100",
  "cubePath": "/demo",
  "pov": {
    "year": "2024",
    "scenario": "Budget",
    "entity": "firm1"
  }
}

响应

响应示例

Copy
{
  "status": true,
  "code": 0,
  "message": null,
  "data": "success"
}

数据复制计算

用于在不同维度组合间复制数据，支持维度表达式语法。

请求

项目

值

HTTP Method

POST

Path

https://xxxx.com/deepfos-server/financial-model-server1-0/copyCalculate

Request Body 字段

字段名

类型

必填

说明

cubeName

String

是

财务模型名称

cubeFolderId

String

否

财务模型目录 ID

cubePath

String

否

财务模型路径

fixMembers

String

否

固定维度成员脚本

formula

String

是

复制计算公式

needCheck

Boolean

否

是否校验

dataAuditSwitch

Boolean

否

是否开启数据审计

Request Body 示例

Copy
{
  "cubeName": "Ana_Cube",
  "cubeFolderId": "100",
  "cubePath": "/demo",
  "fixMembers": "entity{firm1}->scenario{Actual}",
  "formula": "year{2025}->period{1}=year{2024}->period{12}",
  "needCheck": true,
  "dataAuditSwitch": true
}

响应

响应示例

Copy
{
  "status": true,
  "code": 0,
  "message": null,
  "data": "success"
}

权限控制接口

更新财务模型权限状态

用于更新财务模型中指定维度组合的审批状态，也可用于预算开版或新增维度成员后初始化对应成员的权限状态。

请求

项目

值

HTTP Method

POST

Path

https://xxxx.com/deepfos-server/financial-model-server1-0/block/pc-status-upsert

Request Body 字段

字段名

类型

必填

说明

cubeName

String

是

财务模型名称

cubeFolderId

String

否

财务模型目录 ID

cubePath

String

否

财务模型路径

status

String

是

审批状态

datablockMap

Object

否

审批单元范围

processMap

Object

否

流程维度范围

Request Body 示例

Copy
{
  "cubeName": "Ana_Cube",
  "cubeFolderId": "100",
  "cubePath": "/demo",
  "status": "1",
  "datablockMap": {
    "Entity": "Entity{Descendant(#root,0)}"
  },
  "processMap": {
    "Year": "Year{2018}",
    "Period": "Period{1}",
    "Version": "Version{Working}",
    "Scenario": "Scenario{Actual}"
  }
}

响应

响应示例

Copy
{
  "status": true,
  "code": 0,
  "message": null,
  "data": true
}

数据审计接口

查询数据变更日志

用于查询财务模型数据的变更历史记录。

请求

项目

值

HTTP Method

POST

Path

https://xxxx.com/deepfos-server/financial-model-server1-0/cube/data/log/list

Request Body 字段

字段名

类型

必填

说明

cubeName

String

是

财务模型名称

cubeFolderId

String

否

财务模型目录 ID

cubePath

String

否

财务模型路径

dimensionData

Object

是

数据定位条件

dimensionData.year

String

否

年度

dimensionData.entity

String

否

主体

dimensionData.account

String

否

科目

Request Body 示例

Copy
{
  "cubeName": "Ana_Cube",
  "cubeFolderId": "100",
  "cubePath": "/demo",
  "dimensionData": {
    "year": "2024",
    "entity": "firm1",
    "account": "Revenue"
  }
}

响应

响应体字段

字段名

类型

说明

type

String

变更来源

data

String

变更后的值

create_time

String

变更时间

op_uid

String

操作人

响应示例

Copy
[
  {
    "type": "表单",
    "data": "1000000",
    "create_time": "2024-03-24 10:30:00",
    "op_uid": "admin@deepfos.com"
  }
]
上一篇：维度
下一篇：Python SDK 文档概述
本页目录

回到顶部

咨询热线

400-821-9199

我们使用 ChatGPT，基于文档中心的内容以及对话上下文回答您的问题。

ctrl+Enter to send

© 2022 先胜云. All Rights Reserved.