财务管理后台接口文档

请求地址

请求地址	请求示例
https://erp.ffffee.com	https://erp.ffffee.com/api/users/login/

一、登录接口

1. 请求地址

请求地址	请求方式	是否需要授权
/api/users/login/	post	否

2. 请求头

json

{
  "headers": {
    "Content-Type": "application/json"
  }
}

3. 请求参数

序号	名称	类型	是否必传	描述
1	name	string	是	用户名
2	password	string	是	密码

请求示例

json

{"name": "李钟意", "password": "123456"}

4. 响应数据

序号	名称	类型	描述	参考值
1	status	Number	请求状态，200：成功 4022：用户名或者密码错误
2	token	String	令牌，后续拿此 token 获取数据
2	name	String	用户名	"李白"
2	email	String	邮箱	"zhangsan@gmail.com"
2	avatar	String	头像 url
3	userFunctionMaps	Object	当前拥有的权限，看 userFunctionMaps 列表	[{"name": "编辑", "moduleId": 3}]
4	msg	String		"获取 token 成功"

5. 响应示例

json

{
  "status": 200,
  "msg": "获取token成功",
  "data": {
    "token": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYzZTI4MjY3ZWI3Yjc4NzEzOGIwZWJkMCIsIm5hbWUiOiLmnY7nmb0iLCJpYXQiOjE2ODI3NTEzMzYsImV4cCI6MTY4Mjc5NDUzNn0.c4IpQhiJwHsYowNDuFJNwhXY_J5olM5_GGpGNfZtDMY",
    "name": "李白",
    "email": "zhangsan@gmail.com",
    "avatar": ""
  }
}

二、获取获取左侧菜单

1. 请求地址

请求地址	请求方式	是否需要授权
/api/menus/	get	是

2. 请求头

Authorization 为登录成功拿到的 token 拼接上 Bearer

json

{
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer xxxxxxxxxxxx"
  }
}

3. 请求参数

无需传入参数

4. 响应数据

序号	名称	类型	描述	备注
1	status	Number	请求状态，200,成功
2	data	Array	数据列表，看下面 data 列表,菜单列表
3	userFunctionMaps	Object	当前拥有的权限，看 userFunctionMaps 列表	[{"name": "编辑", "moduleId": 3}]
4	msg	String	"Ok"

序号	data	类型	描述	参考值
1	meta	Object	其他字段，看下面 Meta	{}
2	parentId	Number	父级菜单 id	-1: 最顶层 id
3	path	String	跳转路径	"/home"
4	hidden	Boolean	true：隐藏 false:展示	false
5	redirect	String	重定向的地址，空则不需要重定向	""
6	id	Number	id 当前菜单 id，唯一的值	1
7	name	String	菜单路由名称，唯一的值	"HOME"
8	date	String	创建日期	"2020-04-04T15:08:35.192Z"
9	remark	String	备注信息	"首页"
10	operator	String	操作者 id	"5e2e824cb433e62319f72611"
11	operatorDate	String	最近更新日期	"2021-09-26T03:31:23.866Z"

序号	meta	类型	描述	参考值
1	title	String	菜单标题-需要展示的菜单名称	"首页"
2	index	Number	关联父级菜单的 name, 可以为空	"HOME" ""
3	icon	String	显示的菜单图标	"/home"
4	isOpe	Boolean	true：有操作权限 false: 只看权限	false

序号	userFunctionMaps	类型	描述	参考值
1	name	String	权限名称，可选值：“编辑”、“查看”	"编辑"
2	moduleId	Number	关联父级菜单的 id	3

5. 响应示例

json

{
  "status": 200,
  "data": [
    {
      "meta": {"title": "首页", "index": "", "icon": "iconfont icon-home6", "isOpe": false},
      "parentId": 0,
      "path": "/home",
      "hidden": false,
      "redirect": "",
      "id": 1,
      "name": "HOME",
      "date": "2020-04-04T15:08:35.192Z",
      "remark": "首页",
      "__v": 0,
      "operator": "5e2e824cb433e62319f72611",
      "operatorDate": "2021-09-26T03:31:23.866Z"
    },
    {
      "meta": {"title": "收入管理", "index": "", "icon": "iconfont icon-shouru", "isOpe": true},
      "parentId": 0,
      "path": "/revenue",
      "hidden": false,
      "redirect": "",
      "id": 3,
      "name": "REVENUE",
      "date": "2020-04-04T15:08:35.194Z",
      "remark": "收入管理",
      "__v": 0,
      "operator": "5e2e824cb433e62319f72611",
      "operatorDate": "2021-09-26T03:31:23.890Z"
    }
    // ...
  ],
  "userFunctionMaps": [
    {"name": "编辑", "moduleId": 3},
    {"name": "查看", "moduleId": 3},
    {"name": "编辑", "moduleId": 21}
    // ...
  ],
  "msg": "ok"
}

三、首页账单状态

1. 请求地址

请求地址	请求方式	是否需要授权
/api/charts/billStatusList/	get	是

2. 请求头

json

{
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer xxxxxxxxxxxx"
  }
}

3. 请求参数

序号	名称	类型	是否必传	描述
1

请求示例

json

{}

4. 响应数据

序号	名称	类型	描述	参考值
1	_id	Number	状态，1：还款中 2：已结清 3：已逾期
2	value	Number	张三金额，单位：分	2884600
3	count	Number	账单数量	20
4	title	String	状态描述还款中/已结清/已逾期	"已逾期"

5. 响应示例

json

{
  "status": 200,
  "msg": "获取数据成功",
  "data": [
    {"_id": 1, "value": 2884600, "count": 20, "title": "还款中"},
    {"_id": 2, "value": 1123400, "count": 1, "title": "已结清"},
    {"_id": 3, "value": 33300, "count": 1, "title": "已逾期"}
  ]
}

三、首页每月账单趋势图

1. 请求地址

请求地址	请求方式	是否需要授权
/api/charts/billMonthCashs/	get	是

2. 请求头

json

{
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer xxxxxxxxxxxx"
  }
}

3. 请求参数

序号	名称	类型	是否必传	描述
1

请求示例

json

{}

4. 响应数据

序号	名称	类型	描述
1	status	Number	200: 成功
2	msg	String	状态描述
3	data	Array	数组，数据列表
4	dateArr	Array[]	x 轴日期范围，二维数组

序号	data	类型	描述	参考值
1	status	Number[]	账单状态,[1]：还款中 [2]:已结清 [3]:已逾期 [1,2,3]:总计	可以转成字符串使用
2	data	{"month": "2022/08/15", "value": 222200}[]	month 月份 value: 金额单位：分

序号	dateArr	类型	描述	参考值
1	[开始时间, 结束时间]	Array[]	二维数组	这是 x 坐标的时间段

5. 响应示例

四、首页-最近待账单

1. 请求地址

请求地址	请求方式	是否需要授权
/api/charts/loan/latest/	get	是

2. 请求头

json

{
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer xxxxxxxxxxxx"
  }
}

3. 请求参数

序号	名称	类型	是否必传	描述
1	page	Number	否	当前页, 从 1 开始
1	pageSize	Number	否	每页多少条, 3

请求示例

https://erp.ffffee.com/api/charts/loan/latest/?page=1&pageSize=3

4. 响应数据

序号	名称	类型	描述
1	status	Number	200: 成功
2	msg	String	状态描述
3	data	Array	数组，数据列表
4	page	Number
5	pageSize	Number
6	statistics	[]	统计数据

序号	data	类型	描述
1	_id	String	账单 id
2	name	String	账单名称
3	total	Number	账单剩余还款金额，单位：分
4	total_all	Number	账单总金额，单位：分
5	from_time	Date	借款日期
6	start_time	Date	开始还款日期
7	type	String	账单类型
8	bank	String	绑定银行卡名称
9	bank_number	String	银行卡后四位
10	stage_total	Number	总分期数量
11	remark	String	备注
12	create_date	Date	创建日期
13	stages	Object	分期信息

序号	名称	类型	描述
1	_id	Number	200: 成功
2	date	Date	创建日期
3	stage	Number	账单期数，第几期
4	status	Number	账单状态 1：还款中 2：已结清 3：已逾期
5	cash	Number	当前账单金额，单位：分

5. 响应示例

json

{
  "status": 200,
  "msg": "获取数据成功",
  "page": 1,
  "pageSize": 3,
  "statistics": [
    {"_id": 3, "value": 33300, "count": 1},
    {"_id": 1, "value": 2884600, "count": 20}
  ],
  "data": [
    {
      "_id": "644cb62da2a853001243d145",
      "name": "1234",
      "platform": {
        "_id": "644cb410a2a853001243cb64",
        "name": "微信钱包",
        "remark": "1234",
        "id": "644cb410a2a853001243cb64"
      },
      "total": 1234300,
      "total_all": 1999800,
      "rate": 2314,
      "from_time": "2022-07-21T06:15:09.000Z",
      "start_time": "2022-07-20T16:00:00.000Z",
      "type": "1",
      "bank": "1234",
      "bank_number": "1234",
      "remark": "1234234",
      "stage_total": 9,
      "stages": {
        "_id": "644cb62da2a853001243d146",
        "date": "2022-07-21T00:00:00.000Z",
        "stage": 1,
        "status": 1,
        "cash": 222200
      },
      "create_date": "2023-04-29T06:16:13.016Z",
      "__v": 0
    }
  ]
}

快速实践指南

入门指南

基础知识

构建镜像

Node.js

Java

Dockerfile最佳实践

直播讲解 docker + nginx

咨询/接单/bug修复/学习交流群

财务管理后台接口文档 ​

请求地址 ​

一、登录接口 ​

1. 请求地址 ​

2. 请求头 ​

3. 请求参数 ​

4. 响应数据 ​

5. 响应示例 ​

二、获取获取左侧菜单 ​

1. 请求地址 ​

2. 请求头 ​

3. 请求参数 ​

4. 响应数据 ​

5. 响应示例 ​

三、首页账单状态 ​

1. 请求地址 ​

2. 请求头 ​

3. 请求参数 ​

4. 响应数据 ​

5. 响应示例 ​

三、首页每月账单趋势图 ​

1. 请求地址 ​

2. 请求头 ​

3. 请求参数 ​

4. 响应数据 ​

5. 响应示例 ​

四、首页-最近待账单 ​

1. 请求地址 ​

2. 请求头 ​

3. 请求参数 ​

4. 响应数据 ​

5. 响应示例 ​

财务管理后台接口文档

请求地址

一、登录接口

1. 请求地址

2. 请求头

3. 请求参数

4. 响应数据

5. 响应示例

二、获取获取左侧菜单

1. 请求地址

2. 请求头

3. 请求参数

4. 响应数据

5. 响应示例

三、首页账单状态

1. 请求地址

2. 请求头

3. 请求参数

4. 响应数据

5. 响应示例

三、首页每月账单趋势图

1. 请求地址

2. 请求头

3. 请求参数

4. 响应数据

5. 响应示例

四、首页-最近待账单

1. 请求地址

2. 请求头

3. 请求参数

4. 响应数据

5. 响应示例