FinTrack API Documentation

Welcome to the FinTrack API documentation. This guide provides detailed information on how to interact with the FinTrack API, which allows you to manage users, categories, transactions, budgets, and analytics.

Table of Contents

1. Users
   • User Register
   • User Login
   • User Profile
2. Categories
   • Create a Category
   • Retrieve Categories
   • Update a Category
   • Delete a Category
3. Transactions
   • Create a Transaction
   • Retrieve Transactions
   • Update a Transaction
   • Delete a Transaction
4. Budgets
   • Create a Budget
   • Retrieve Budgets
   • Update a Budget
5. Analytics
   • 30 Days Analytics
   • 90 Days Analytics
   • Year Analytics
6. Test

Installation

To get started with FinTrack, follow these steps:

1. Clone the repository:

   git clone https://github.com/ripionck/fin-track-api.git
   cd fin-track-api

2. Install dependencies:

   yarn install

3. Set up environment variables:

   • Create a .env file in the server directory and add the following variables:

     MONGO_URI=your_mongodb_connection_string
     JWT_SECRET=your_jwt_secret_key
     PORT=5000

---

Thank you for using FinTrack! We hope it helps you manage your finances more effectively.

Users

User Register

Register a new user.

Endpoint: POST http://localhost:5000/api/users/register

Body:

{
  "firstName": "Test",
  "lastName": "User",
  "email": "[email protected]", 
  "password": "password123" 
}

User Login

Login an existing user.

Endpoint: POST http://localhost:5000/api/users/login/

Body:

{
  "email": "[email protected]", 
  "password": "Password123" 
}

User Profile

Retrieve the profile of the logged-in user.

Endpoint: GET http://localhost:5000/api/users/me

Authorization: Bearer Token

Token: <token>

---

Categories

Create a Category

Create a new category.

Endpoint: POST http://localhost:5000/api/categories/

Authorization: Bearer Token

Token: <token>

Body:

{
    "name": "Drink",
    "icon": "🍸",
    "color": "#00FF00"
}

Retrieve Categories

Retrieve all categories.

Endpoint: GET http://localhost:5000/api/categories/

Authorization: Bearer Token

Token: <token>

Update a Category

Update an existing category.

Endpoint: PUT http://localhost:5000/api/categories/67b1dc5450c9bf327c120d25

Authorization: Bearer Token

Token: <token>

Body:

{
    "name": "Chinese Food",
    "icon": "🍕",
    "color": "#00FF00"
}

Delete a Category

Delete a category.

Endpoint: DELETE http://localhost:5000/api/categories/67b1dc5450c9bf327c120d25

Authorization: Bearer Token

Token: <token>

---

Transactions

Create a Transaction

Create a new transaction.

Endpoint: POST http://localhost:5000/api/transactions/

Authorization: Bearer Token

Token: <token>

Body:

{
  "date": "2025-02-05",
  "description": "Monthly Salary",
  "category": "Income",
  "type": "Income",
  "amount": 12000
}

Retrieve Transactions

Retrieve all transactions.

Endpoint: GET http://localhost:5000/api/transactions/

Authorization: Bearer Token

Token: <token>

Update a Transaction

Update an existing transaction.

Endpoint: PUT http://localhost:5000/api/transactions/67b1e06450c9bf327c120d3c

Authorization: Bearer Token

Token: <token>

Body:

{
  "date": "2024-08-01",
  "description": "Shipping",
  "amount": 2000,
  "categoryId": "67b1dfd150c9bf327c120d36", 
  "type": "expense"
}

Delete a Transaction

Delete a transaction.

Endpoint: DELETE http://localhost:5000/api/transactions/67b1e06450c9bf327c120d3c

Authorization: Bearer Token

Token: <token>

---

Budgets

Create a Budget

Create a new budget.

Endpoint: POST http://localhost:5000/api/budgets/

Authorization: Bearer Token

Token: <token>

Body:

{
  "category": "Food",
  "limit": 500
}

Retrieve Budgets

Retrieve all budgets.

Endpoint: GET http://localhost:5000/api/budgets/

Authorization: Bearer Token

Token: <token>

Update a Budget

Update an existing budget.

Endpoint: PUT http://localhost:5000/api/budgets/67b1e7f22d15c963d33f4f01

Authorization: Bearer Token

Token: <token>

Body:

{
  "categoryId": "67b1dbb650c9bf327c120d21",
  "limit": 5000,
  "startDate": "2024-08-01",
  "endDate": "2024-08-31"
}

---

Analytics

30 Days Analytics

Retrieve analytics for the last 30 days.

Endpoint: GET http://localhost:5000/api/analytics/30days

Authorization: Bearer Token

Token: <token>

90 Days Analytics

Retrieve analytics for the last 90 days.

Endpoint: GET http://localhost:5000/api/analytics/90days

Authorization: Bearer Token

Token: <token>

Year Analytics

Retrieve analytics for the current year.

Endpoint: GET http://localhost:5000/api/analytics/current-year

Authorization: Bearer Token

Token: <token>

---

Test

Test

Test endpoint.

Endpoint: GET http://localhost:5000/api/test

---

For any issues or further assistance, please contact the support team.