incomeRoutes.md

API Endpoints

Expense Routes

Get Expense By ID

• URL: /api/v1/expenses/:id

• • Method: GET
• • Description: Gets expense data by ID.
• • Authorization: Requires registered user privileges.

• Request URL Parameters:

  • id: 123

• Response:

  • Status: 200 OK
  • Body:

  •     {
      "success": true,
      "data": {
        "id": number,
        "user_id": number,
        "created_at": "YYYY-MM-DDTHH:mm:ss.SSS Z",
        "description": string,
        "amount": number,
        "date": "YYYY-MM-DDTHH:mm:ss.SSS Z",
        "category": number
        }
      }

• Example:

  curl -X GET "http://localhost:8080/api/v1/expenses/123"

Get All Expenses

• URL: /api/v1/expenses

• • Method: GET
• • Description: Retrieves a paginated list of all expenses with optional filtering and sorting capabilities.
• • Authorization: Requires registered user privileges.

• Request Parameters:

  • page (optional, number): The current page number. Defaults to 1.
  • limit (optional, number): The number of expenses to retrieve per page. Defaults to 15.
  • category (optional, number): Filter expenses by a specific category ID.
  • order (optional, string): The field to sort by (requires direction parameter). Options include "description", "amount", or "date".
  • Direction (optional, string): The sorting direction (requires order parameter). Options include "asc" or "desc".

• Response:

  • Status: 200 OK
  • Body:

  •     {
        "success": true,
        "totalPages": number, // Total number of pages available
        "categories": array, // Array of all expense categories
        "hasMore": boolean, // Flag indicating if there are more pages
        "data": array // Array of expense objects
      }

    • data: Array of expense objects containing the following properties:
  • id: number (Expense ID)
  • description: string (Expense description)
  • amount: number (Expense amount)
  • date: string (Expense date)
  • category: string (Expense category name)
  • category_id: number (Expense category ID)

• Example:

curl -X GET "http://localhost:8080/api/v1/expenses?page=2&limit=10"

Get All Expenses Total

• URL: /api/v1/expenses-total

• • Method: GET
• • Description: Retrieves the total amount spent for each year.
• • Authorization: Requires registered user privileges.

• Response:

  • Status: 200 OK
  • Body:

  •      {
        "success": true,
        "data": [
          {
            "year": number,
            "amount": number
          },
          {
            "year": number,
            "amount": number
          },
          // ... (other years)
        ]
      }

• Example:

curl -X GET "http://localhost:8080/api/v1/expenses-total"

Get Expenses By Category

• URL: /api/v1/expenses-category

• • Method: GET
• • Description: Retrieves a list of expenses belonging to a specific category.
• • Authorization: Requires registered user privileges.

• Request Parameters:

  • category (optional, number): The category ID to filter by. Defaults to "1" if not provided.

• Response:

  • Status: 200 OK

  • Body:

  •     {
        "success": true,
        "data": {
          "valuesData": array,
          "categoryData": object
        }
      }

  • • valuesData: Array of expense objects containing the following properties:
      • id: number (Expense ID) (may be null)
      • category: string (Expense category name) (may be null)
      • year: unknown (Year of the expense) (data type might be unexpected)
      • amount: number (Expense amount)

  • • categoryData: Object containing information about the filtered category:

      • id: number (Category ID)
      • category: string (Category name)

• Example:

curl -X GET "http://localhost:8080/api/v1/expenses-category?category=5"

Get Expenses By Year

• URL: /api/v1/expense-year

• • Method: GET
• • Description: Retrieves a list of expenses incurred in a particular year.
• • Authorization: Requires registered user privileges.

• Request Parameters:

  • year (optional, string): The year to filter by. Defaults to "2023" if not provided.

• Response:

  • Status: 200 OK
  • Body:

  • {
      "success": true,
      "data": {
        "id": 12,
        "category": 1,
        "year": 2023,
        "amount": 20000
      }
    }

• Example:

curl -X GET "http://localhost:8080/api/v1/expense-year?year=2024"

Get Expenses By Month

• URL: /api/v1/expense-month

• • Method: GET
• • Description: Retrieves a breakdown of expenses by month within a specified year and category.
• • Authorization: Requires registered user privileges.

• Request Parameters:

  • year (optional, string): The year to filter by. Defaults to "2023" if not provided.
  • category (optional, number): The category ID to filter by. Defaults to 1 if not provided.

• Response:

  • Status: 200 OK
  • Body:

  • {
      "success": true,
      "data": [
        {
          "amount": 1000.0,
          "id": 3,
          "category": "Category Name",
          "year": 2024,
          "month": 6
        }
      ]
    }

• Example:

curl -X GET "http://localhost:8080/api/v1/expense-month?year=2024&category=2"