update API doc

3 years ago · 3873bd1cdc
parent d2312648e7
commit 3873bd1cdc
1 changed files with 17 additions and 0 deletions
--- a/API.md
+++ b/API.md
@ -248,3 +248,20 @@ Response:
  "decimal": int,
 }
 ```
+## GET /income
+Get the total amount of income in each category
+
+Response:
+```json
+{
+  "status": int,
+  "income_by_category": {
+    "example_category": {
+      "currency": string,
+      "whole": int,
+      "decimal": int,
+    },
+    ...
+  }
+}
+```