@[TOC]
## 接口介绍
在客户使用星瀚系统时，存在第三方系统对接时会有需要查询现金流量发生及本年累计的场景，为此提供了API接口供使用，可以按照现金流量项目或者核算维度的角度查询**单组织某个期间**发生数据。
## 接口说明
### 接口路径
开发服务云-->开放平台-->API开发
### 接口配置
#### 5.0.020及以后版本
系统已经在开发平台预置了余额取数接口服务，直接使用即可。详细使用可以参看API文档，菜单为API文档。
API服务路径：开放平台-->API管理列表-->财务云-->总账-->余额接口-->getCashflow 现金流量接口
请求url格式:https://xxx.kdcloud.com/test/kapi/v2/gl/getCashflowApi
#### 5.0.020以前版本
5.0.020版本之前需要自己新建API服务。路径：开放平台-->其他-->API服务管理1.0
1、新增API服务，建立总账的自定义调用接口
2、建立总账金流量服务getCashflowService，选择post方式
3、建立插件kd.fi.gl.api.CashflowServiceApiHelper
这样一个自定义的操作服务就注册好了，访问地址为星瀚系统地址+/api+API高级信息中的URL内容。
### 使用说明
建立参数类CashflowQueryParamApi (可不建参数类，参数类主要为了方便传参)
```java
public class CashflowQueryParamApi{
//查询字段
private List<String> selectors = new ArrayList<String>();
//组织编码
private String orgNumber;
//账簿类型编码
private String bookTypeNumber;
//期间编码
private String periodNumber;
//币别编码
private String currencyNumber;
//现金流量项目
priate String[] cfitemNumbers;
//分组字段；只包含：余额表字段与查询的核算维度
private List<String> groupBys = new ArrayList<String>();
// 核算维度
private Map<String, Object> assgrps = new HashMap<String, Object>();
// 公共维度
private Map<String, List<String>> comassist = new HashMap<>(1);
// 省略getter setter方法
}
```
#### 参数字段说明
| 字段 | 说明 | 备注 |
| ------------ | ------------ | ------------ |
| selectors | 需要查询的余额表字段，字段标识对应gl_balance元数据，后面会有介绍 | 必录，selector加了period期间字段则只查询当期有发生的数据，当期无发生不返回 |
| orgNumber | 核算组织编码 | 必录 |
| bookTypeNumber | 账簿类型编码 | 必录 |
| periodNumber | 期间编码 | 必录 |
| currencyNumber | 币别编码 | 非必录，不传查询综合本位币 |
| cfitemNumbers | 现金流量项目 | 科目必录 |
| groupBys | 分组字段 | |
#### 现金流量余额表gl_cashflow字段说明
| 字段 | 说明 | 备注 |
| ------------ | ------------ | ------------ |
| org | 核算组织 | |
| booktype | 账簿类型 | |
| period | 期间 | 该维度余额记录的发生期间 |
| endperiod | 结束期间 | 该维度下一个发生期间，无下一期则该值为99999999999L，表示最大期间 |
| cfitem | 现金流量项目 | |
| currency | 币别 | |
| assgrp | 核算维度 | 弹性域，维度的横表组合 |
| amount | 本期发生 | |
| yearamount | 本年累计 | |
| count | 凭证分录数 | 用于记录对应余额的汇总凭证分录发生数 |
| comassist1 | 公共维度1 | 对应科目表的公共维度1，不启用公共维度则不需要关心 |
| comassist2 | 公共维度2 | 对应科目表的公共维度2，不启用公共维度则不需要关心 |
#### API请求结构示例
查询组织org1下，202201期，0201.01并且客户维度挂了“CUST000002”，供应商挂了“Sup-004237”的本期发生额
```json
{
"selectors":[
"org",
"amount"
],
"orgNumber":"org1",
"bookTypeNumber":"100001",
"periodNumber":"202201",
"currencyNumber":"CNY",
"cfitemNumbers":[
"0201.01"
],
"assgrps":{
"0002":"Sup-004237",
"0001":"CUST000002"
},
"groupBys":[
"org"
]
}
```
##### postman调用示例
#### API返回结构示例
```json
{
"data":"",
"errorCode":"",
"message":"",
"status":true
}
```
