{"info":{"_postman_id":"e6835404-4c63-423a-95ae-ccaefda2c91a","name":"SplitSmartpro","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"50839289","collectionId":"e6835404-4c63-423a-95ae-ccaefda2c91a","publishedId":"2sBXqKoKuR","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-05-02T08:53:40.000Z"},"item":[{"name":"Expenses","item":[{"name":"Add expense","id":"e09b5f35-b571-46e4-a8c1-e5728d2acbf6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"groupId\": \"69f5a8dc18f1be19d2d68a79\", \"title\": \"Pizza\", \"amount\": 50, \"paidBy\": \"69f5a8dc18f1be19d2d68a79\", \"splitType\": \"equal\"}","options":{"raw":{"language":"json"}}},"url":"http://localhost:5000/api/expenses","urlObject":{"protocol":"http","port":"5000","path":["api","expenses"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"e7ec564a-9e31-44d9-8d74-1e07e60fa2a0","name":"Add expense","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"groupId\": \"69f5a8dc18f1be19d2d68a79\", \"title\": \"Pizza\", \"amount\": 50, \"paidBy\": \"69f5a8dc18f1be19d2d68a79\", \"splitType\": \"equal\"}","options":{"raw":{"language":"json"}}},"url":"http://localhost:5000/api/expenses"},"status":"Created","code":201,"_postman_previewlanguage":null,"header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"352"},{"key":"ETag","value":"W/\"160-oglZQXgFLy+GOioi26a4wv1EcAw\""},{"key":"Date","value":"Sat, 02 May 2026 07:42:39 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"groupId\": \"69f5a8dc18f1be19d2d68a79\",\n \"title\": \"Pizza\",\n \"amount\": 50,\n \"paidBy\": null,\n \"splitType\": \"equal\",\n \"splits\": [\n {\n \"user\": {\n \"_id\": \"69f593ba649b41cd797085dc\",\n \"name\": \"Test User\",\n \"email\": \"test@example.com\"\n },\n \"amount\": 50\n }\n ],\n \"category\": \"Others\",\n \"_id\": \"69f5aaef18f1be19d2d68a89\",\n \"createdAt\": \"2026-05-02T07:42:39.895Z\",\n \"updatedAt\": \"2026-05-02T07:42:39.895Z\",\n \"__v\": 0\n}"}],"_postman_id":"e09b5f35-b571-46e4-a8c1-e5728d2acbf6"},{"name":"View Expenses","id":"c0a86ed9-37cc-4f19-926e-7d7521a5b0bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:5000/api/expenses/:groupId","description":"

Get Expenses by Group ID

This endpoint retrieves a list of expenses associated with a specific group identified by groupId. It is useful for obtaining all expense records for a particular group, allowing users to manage and review shared financial transactions.

Request Parameters

groupId (path parameter): The unique identifier for the group whose expenses are to be fetched.

Response Structure

The response will be an array of expense objects, each containing the following fields:

_id: Unique identifier for the expense.
groupId: The ID of the group associated with the expense.
title: The title or description of the expense.
amount: The total amount of the expense.
paidBy: The identifier of the user who paid for the expense (can be null).
splitType: The method used for splitting the expense (e.g., equally, by percentage).
splits: An array of split details, where each split includes:
- user: An object containing:
  - _id: Unique identifier for the user.
  - name: The name of the user.
  - email: The email of the user.
  \n
- amount: The amount that the user is responsible for.
\n
category: The category under which the expense falls (e.g., food, travel).
createdAt: The timestamp when the expense was created.
updatedAt: The timestamp when the expense was last updated.
__v: Version key for the expense document.

This structured response allows clients to easily understand and manipulate the expense data for the specified group.

\n","urlObject":{"protocol":"http","port":"5000","path":["api","expenses",":groupId"],"host":["localhost"],"query":[],"variable":[{"type":"any","value":"69f5a8dc18f1be19d2d68a79","key":"groupId"}]}},"response":[{"id":"291492c1-da48-472a-8e1c-2f0b086cd44f","name":"View Expenses","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://localhost:5000/api/expenses/:groupId","protocol":"http","host":["localhost"],"port":"5000","path":["api","expenses",":groupId"],"variable":[{"key":"groupId","value":"69f5a8dc18f1be19d2d68a79"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"354"},{"key":"ETag","value":"W/\"162-XXXI9L368S+SV+zKxK2bWCVglUo\""},{"key":"Date","value":"Sat, 02 May 2026 07:44:52 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_id\": \"69f5aaef18f1be19d2d68a89\",\n \"groupId\": \"69f5a8dc18f1be19d2d68a79\",\n \"title\": \"Pizza\",\n \"amount\": 50,\n \"paidBy\": null,\n \"splitType\": \"equal\",\n \"splits\": [\n {\n \"user\": {\n \"_id\": \"69f593ba649b41cd797085dc\",\n \"name\": \"Test User\",\n \"email\": \"test@example.com\"\n },\n \"amount\": 50\n }\n ],\n \"category\": \"Others\",\n \"createdAt\": \"2026-05-02T07:42:39.895Z\",\n \"updatedAt\": \"2026-05-02T07:42:39.895Z\",\n \"__v\": 0\n }\n]"}],"_postman_id":"c0a86ed9-37cc-4f19-926e-7d7521a5b0bb"},{"name":"Recent Expense","id":"6bd89032-df27-4464-a86c-c8e021e58f58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:5000/api/expenses/recent","description":"

Get Recent Expenses

This endpoint retrieves a list of recent expenses recorded in the system.

Request

Method: GET
Endpoint: http://localhost:5000/api/expenses/recent

Response

The response will return a JSON array containing objects that represent recent expenses. Each expense object includes the following fields:

_id: Unique identifier for the expense.
groupId: An object containing:
- _id: Unique identifier for the group.
- name: Name of the group.
\n
title: Title of the expense.
amount: The total amount of the expense (numeric).
paidBy: Identifier of the user who paid the expense (can be null).
splitType: Type of split for the expense.
splits: An array of objects representing how the expense is divided among users, each containing:
- user: Identifier of the user.
- amount: Amount attributed to the user (numeric).
\n
category: Category of the expense.
createdAt: Timestamp of when the expense was created.
updatedAt: Timestamp of when the expense was last updated.
__v: Version key for the expense document.

Example Response

[\n  {\n    \"_id\": \"\",\n    \"groupId\": {\n      \"_id\": \"\",\n      \"name\": \"\"\n    },\n    \"title\": \"\",\n    \"amount\": 0,\n    \"paidBy\": null,\n    \"splitType\": \"\",\n    \"splits\": [\n      {\n        \"user\": \"\",\n        \"amount\": 0\n      }\n    ],\n    \"category\": \"\",\n    \"createdAt\": \"\",\n    \"updatedAt\": \"\",\n    \"__v\": 0\n  }\n]\n

This structure allows clients to easily parse and utilize the recent expenses data for further processing or display.

\n","urlObject":{"protocol":"http","port":"5000","path":["api","expenses","recent"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"139e4de4-17bd-4bf6-a220-b79e07487313","name":"Recent Expense","originalRequest":{"method":"GET","header":[],"url":"http://localhost:5000/api/expenses/recent"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"330"},{"key":"ETag","value":"W/\"14a-aORZJGh9U63Nyv2ZK2INt2AuG1Q\""},{"key":"Date","value":"Sat, 02 May 2026 08:09:18 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_id\": \"69f5aaef18f1be19d2d68a89\",\n \"groupId\": {\n \"_id\": \"69f5a8dc18f1be19d2d68a79\",\n \"name\": \"Office Lunch\"\n },\n \"title\": \"Pizza\",\n \"amount\": 50,\n \"paidBy\": null,\n \"splitType\": \"equal\",\n \"splits\": [\n {\n \"user\": \"69f593ba649b41cd797085dc\",\n \"amount\": 50\n }\n ],\n \"category\": \"Others\",\n \"createdAt\": \"2026-05-02T07:42:39.895Z\",\n \"updatedAt\": \"2026-05-02T07:42:39.895Z\",\n \"__v\": 0\n }\n]"}],"_postman_id":"6bd89032-df27-4464-a86c-c8e021e58f58"}],"id":"b961c443-4ef2-4927-b4b3-4465be0b5389","description":"

StartFragment

The Expenses module is the core functionality of SplitSmart Pro that allows users to record, manage, and track shared expenses within groups. It ensures fair splitting and clear visibility of financial activities among members.

🔹 Features:

Add Expense\n
\n
```
  Users can add a new expense to a group.  \n  \n
```
- Includes details like:
  \n
  - Amount 💰
    \n
  - Description 📝
    \n
  - Paid by 👤
    \n
  - Split among members 👥
    \n
  \n
- Supports equal or custom splits.
  \n
\n

View Expenses\n
\n
```
  Retrieve all expenses for a specific group.  \n  \n
```
- Displays:
  \n
  - Expense history
    \n
  - Who paid
    \n
  - How the amount was split
    \n
  \n
\n

Recent Expenses\n
\n
```
  Fetch the most recent transactions.  \n  \n
```
- Helps users quickly track latest activity.
\n

🎯 Purpose:

This module ensures accurate tracking of shared spending and eliminates confusion by clearly recording every transaction within a group.

EndFragment

\n","_postman_id":"b961c443-4ef2-4927-b4b3-4465be0b5389"},{"name":"Financial Status","item":[{"name":"User Summary","id":"0c7881d0-72f5-4d64-97bb-604d135f30c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:5000/api/balance/summary","description":"

API Endpoint: Get Balance Summary

Description

This endpoint retrieves a summary of the user's balance within the application. It provides a concise overview of the financial interactions involving the user, including amounts owed to the user, amounts the user owes, and the net balance.

Request

Method: GET
URL: http://localhost:5000/api/balance/summary

Input Parameters

This endpoint does not require any input parameters.

Response

The response is a JSON object containing the following fields:

totalOwedToUser: (integer) The total amount owed to the user by others.
totalUserOwes: (integer) The total amount the user owes to others.
netBalance: (integer) The net balance calculated as totalOwedToUser minus totalUserOwes.
groupCount: (integer) The number of groups the user is involved with.

Example Response

{\n  \"totalOwedToUser\": 0,\n  \"totalUserOwes\": 0,\n  \"netBalance\": 0,\n  \"groupCount\": 0\n}\n

Notes

This endpoint is useful for users to quickly assess their financial standing in relation to other users and groups within the application.

\n","urlObject":{"protocol":"http","port":"5000","path":["api","balance","summary"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"d8b12ca1-7d3f-4d66-918d-dc9fec5026f4","name":"User Summary","originalRequest":{"method":"GET","header":[],"url":"http://localhost:5000/api/balance/summary"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"72"},{"key":"ETag","value":"W/\"48-yzgVqUKoTWMWodXuLf2wQ7kWMlg\""},{"key":"Date","value":"Sat, 02 May 2026 08:10:45 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"totalOwedToUser\": 0,\n \"totalUserOwes\": 50,\n \"netBalance\": -50,\n \"groupCount\": 1\n}"}],"_postman_id":"0c7881d0-72f5-4d64-97bb-604d135f30c1"},{"name":"Activity Feed","id":"d1035b61-d571-4518-a88d-51ed34cb9a71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:5000/api/balance/:groupId","description":"

API Endpoint: Get Group Balance

Method

GET

Endpoint

http://localhost:5000/api/balance/:groupId

Description

This endpoint retrieves the balance information for a specific group identified by groupId. It provides details about the net balance of users within the group and any simplified debts between users.

Parameters

Path Parameter
- groupId (string): The unique identifier for the group whose balance information is being requested.
\n

Expected Response Format

The response will be in JSON format and contains two main components:

balances: An array of objects representing each user's balance within the group. Each object includes:
\n
- user: An object containing user details.
  - _id: The unique identifier of the user.
  - name: The name of the user.
  - email: The email of the user.
  \n
- netBalance: A numeric value representing the user's net balance.
\n
simplifiedDebts: An array of objects representing simplified debt relationships between users. Each object includes:
\n
- from: An object containing details of the user who owes money.
  - _id: The unique identifier of the user.
  - name: The name of the user.
  \n
- to: An object containing details of the user who is owed money.
- amount: A numeric value representing the amount of debt.
\n

Example Response

{\n  \"balances\": [\n    {\n      \"user\": {\n        \"_id\": \"\",\n        \"name\": \"\",\n        \"email\": \"\"\n      },\n      \"netBalance\": 0\n    }\n  ],\n  \"simplifiedDebts\": [\n    {\n      \"from\": {\n        \"_id\": \"\",\n        \"name\": \"\"\n      },\n      \"to\": {},\n      \"amount\": 0\n    }\n  ]\n}\n

\n","urlObject":{"protocol":"http","port":"5000","path":["api","balance",":groupId"],"host":["localhost"],"query":[],"variable":[{"type":"any","value":"69f5a8dc18f1be19d2d68a79","key":"groupId"}]}},"response":[{"id":"70f5cca1-1c6f-446a-8558-32748430d4d9","name":"Activity Feed","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://localhost:5000/api/balance/:groupId","protocol":"http","host":["localhost"],"port":"5000","path":["api","balance",":groupId"],"variable":[{"key":"groupId","value":"69f5a8dc18f1be19d2d68a79"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"224"},{"key":"ETag","value":"W/\"e0-fLtmWcAI7syyNK8FEaeAcCIiL0g\""},{"key":"Date","value":"Sat, 02 May 2026 08:12:04 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"balances\": [\n {\n \"user\": {\n \"_id\": \"69f593ba649b41cd797085dc\",\n \"name\": \"Test User\",\n \"email\": \"test@example.com\"\n },\n \"netBalance\": -50\n }\n ],\n \"simplifiedDebts\": [\n {\n \"from\": {\n \"_id\": \"69f593ba649b41cd797085dc\",\n \"name\": \"Test User\"\n },\n \"to\": {},\n \"amount\": 50\n }\n ]\n}"}],"_postman_id":"d1035b61-d571-4518-a88d-51ed34cb9a71"}],"id":"0ffbfe63-cc7f-43de-871c-85b1c502ac2d","description":"

StartFragment

The Financial Status module provides users with a clear overview of their current financial standing across all groups. It helps track balances, dues, and recent activities in one place.

🔹 Features:

User Summary\n

  Displays total balance (you owe / you are owed)  \n  \n

Aggregated data across all groups

Activity Feed\n
\n
```
  Shows recent financial activities  \n  \n
```
- Includes expenses added, settlements made, and updates
\n

🎯 Purpose:

To give users a quick snapshot of their financial health and help them stay informed about ongoing transactions.

EndFragment

\n","_postman_id":"0ffbfe63-cc7f-43de-871c-85b1c502ac2d"},{"name":"Authentication","item":[{"name":"Sign-Up","id":"6954995e-74e8-42ee-b420-a214b9eb437d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Test User2\",\r\n \"email\": \"test2@example.com\",\r\n \"password\": \"password123\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"http://localhost:5000/api/auth/signup","description":"\n

This endpoint allows users to create a new account by providing their details.

Request

Method: POST
\n
Endpoint: http://localhost:5000/api/auth/signup
\n

Request Body

The request must include a JSON object with the following parameters:

name (string): The full name of the user.
\n
email (string): The email address of the user.
\n
password (string): The password for the user's account.
\n

Example Request Body:

{\n  \"name\": \"Test User2\",\n  \"email\": \"test2@example.com\",\n  \"password\": \"password123\"\n}\n\n

Response

On successful account creation, the API responds with a JSON object containing:

user: An object with user details including:
\n
- _id: The unique identifier for the user.
  \n
- name: The name of the user.
  \n
- email: The email of the user.
  \n
\n
token: A JWT token for authenticating subsequent requests.
\n

Example Response:

{\n  \"user\": {\n    \"_id\": \"\",\n    \"name\": \"\",\n    \"email\": \"\"\n  },\n  \"token\": \"\"\n}\n\n

Notes

Ensure that the email provided is unique and valid.
\n
The password should meet security requirements as defined by the application.
\n

\n","urlObject":{"protocol":"http","port":"5000","path":["api","auth","signup"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"d97add51-4798-4f16-9514-1284b7245b22","name":"Sign-Up","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Test User2\",\r\n \"email\": \"test2@example.com\",\r\n \"password\": \"password123\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"http://localhost:5000/api/auth/signup"},"status":"Created","code":201,"_postman_previewlanguage":null,"header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"310"},{"key":"ETag","value":"W/\"136-INtI8RBIOpQIJb8IXtZfqUd2HCQ\""},{"key":"Date","value":"Sat, 02 May 2026 08:18:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"user\": {\n \"_id\": \"69f5b36f18f1be19d2d68ab5\",\n \"name\": \"Test User2\",\n \"email\": \"test2@example.com\"\n },\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY5ZjViMzZmMThmMWJlMTlkMmQ2OGFiNSIsImVtYWlsIjoidGVzdDJAZXhhbXBsZS5jb20iLCJpYXQiOjE3Nzc3MDk5MzUsImV4cCI6MTc3ODMxNDczNX0.hPXPv-6-pruDwxlmbsjM6r-3gj5mKFMYVmsxQ313ZPg\"\n}"}],"_postman_id":"6954995e-74e8-42ee-b420-a214b9eb437d"},{"name":"Log-In","id":"2c64748e-1e01-4525-8634-9580229df2ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"test2@example.com\",\r\n \"password\": \"password123\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"http://localhost:5000/api/auth/login","urlObject":{"protocol":"http","port":"5000","path":["api","auth","login"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"3cfee314-0844-4724-82e8-44359f51da44","name":"Log-In","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"test2@example.com\",\r\n \"password\": \"password123\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"http://localhost:5000/api/auth/login"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"310"},{"key":"ETag","value":"W/\"136-HdVoAAKqENpEy/4aqfq1Ow+Fl60\""},{"key":"Date","value":"Sat, 02 May 2026 08:20:13 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"user\": {\n \"_id\": \"69f5b36f18f1be19d2d68ab5\",\n \"name\": \"Test User2\",\n \"email\": \"test2@example.com\"\n },\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY5ZjViMzZmMThmMWJlMTlkMmQ2OGFiNSIsImVtYWlsIjoidGVzdDJAZXhhbXBsZS5jb20iLCJpYXQiOjE3Nzc3MTAwMTMsImV4cCI6MTc3ODMxNDgxM30.bZ-pKvQ0m4nkJnBjVU7CHjmBxHj4gfLQ5Cno_ltwl6M\"\n}"}],"_postman_id":"2c64748e-1e01-4525-8634-9580229df2ac"}],"id":"58e6308b-7180-4782-b896-f63d876e6f71","description":"

StartFragment

The Authentication module ensures secure access to the application by verifying user identity and managing sessions.

🔹 Features:

  New users can create an account securely  \n  \n

Log-In\n

  Existing users can access their account using credentials  \n  \n

Google Authentication\n

  Quick and secure login using Google account\n

🎯 Purpose:

To protect user data and provide a seamless and secure login experience.

EndFragment

\n","_postman_id":"58e6308b-7180-4782-b896-f63d876e6f71"},{"name":"Group Management","item":[{"name":"Create a group","id":"5dcbd355-2b19-439a-912b-0eb6317a28a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"name\": \"Office Lunch\", \"description\": \"Daily food splits\"}","options":{"raw":{"language":"json"}}},"url":"http://localhost:5000/api/groups","description":"

Create a New Group

This endpoint allows you to create a new group by providing the necessary details such as the group's name and description. Upon successful creation, the API will return the details of the newly created group, including its members and metadata.

Request

Method: POST
\n
URL: http://localhost:5000/api/groups
\n
Content-Type: application/json
\n

Request Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
`name`	string	The name of the group.
`description`	string	A brief description of the group.

Example Request Body:

{\n  \"name\": \"Office Lunch\",\n  \"description\": \"Daily food splits\"\n}\n\n

Response

Status Code: 201 Created
\n
Content-Type: application/json
\n

The response will contain the following structure:

{\n  \"name\": \"\",\n  \"description\": \"\",\n  \"members\": [\n    {\n      \"_id\": \"\",\n      \"name\": \"\",\n      \"email\": \"\"\n    }\n  ],\n  \"createdBy\": \"\",\n  \"status\": \"\",\n  \"_id\": \"\",\n  \"inviteCode\": \"\",\n  \"createdAt\": \"\",\n  \"updatedAt\": \"\",\n  \"__v\": 0\n}\n\n

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
`name`	string	The name of the created group.
`description`	string	The description of the created group.
`members`	array	List of members in the group, each with an ID, name, and email.
`createdBy`	string	The ID of the user who created the group.
`status`	string	The current status of the group.
`_id`	string	Unique identifier for the group.
`inviteCode`	string	Code used for inviting others to the group.
`createdAt`	string	Timestamp when the group was created.
`updatedAt`	string	Timestamp when the group was last updated.
`__v`	integer	Version key for the document.

Important Notes

Ensure that the name and description fields are provided in the request body.
\n
The response includes a list of members, which will initially be empty upon group creation.
\n
The _id and inviteCode fields are generated by the server and will be unique for each group created.
\n

\n","urlObject":{"protocol":"http","port":"5000","path":["api","groups"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"46c4bae3-35da-4281-a6ed-5b6ada75118e","name":"Create a group","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"name\": \"Office Lunch\", \"description\": \"Daily food splits\"}","options":{"raw":{"language":"json"}}},"url":"http://localhost:5000/api/groups"},"status":"Created","code":201,"_postman_previewlanguage":null,"header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"352"},{"key":"ETag","value":"W/\"160-mug8k4hTBBPaLK+dY0mWnMstQA0\""},{"key":"Date","value":"Sat, 02 May 2026 08:22:45 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Office Lunch\",\n \"description\": \"Daily food splits\",\n \"members\": [\n {\n \"_id\": \"69f593ba649b41cd797085dc\",\n \"name\": \"Test User\",\n \"email\": \"test@example.com\"\n }\n ],\n \"createdBy\": \"69f593ba649b41cd797085dc\",\n \"status\": \"active\",\n \"_id\": \"69f5b45518f1be19d2d68ab9\",\n \"inviteCode\": \"AVCn_m99aN\",\n \"createdAt\": \"2026-05-02T08:22:45.855Z\",\n \"updatedAt\": \"2026-05-02T08:22:45.855Z\",\n \"__v\": 0\n}"}],"_postman_id":"5dcbd355-2b19-439a-912b-0eb6317a28a8"},{"name":"Get my group","id":"65b75b0a-b2ed-4da8-8e0b-c768d68d632d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:5000/api/groups","description":"

API Endpoint: Retrieve Groups

Description

This endpoint allows users to retrieve a list of groups from the server. Each group contains various attributes that provide information about the group, its members, and its creator.

Request Method

GET

Request URL

http://localhost:5000/api/groups

Response Structure

Upon a successful request, the server will return a JSON array of group objects. Each group object contains the following fields:

_id: (String) Unique identifier for the group.
name: (String) The name of the group.
description: (String) A brief description of the group.
members: (Array) An array of member objects, each containing:
- _id: (String) Unique identifier for the member.
- name: (String) The name of the member.
- email: (String) The email address of the member.
\n
createdBy: (Object) Information about the creator of the group, containing:
- _id: (String) Unique identifier for the creator.
- name: (String) The name of the creator.
- email: (String) The email address of the creator.
\n
status: (String) The current status of the group.
inviteCode: (String) An invitation code for joining the group.
createdAt: (String) Timestamp indicating when the group was created.
updatedAt: (String) Timestamp indicating when the group was last updated.
__v: (Number) Version key for the group document.

Example Response

[\n    {\n        \"_id\": \"groupId1\",\n        \"name\": \"Group Name\",\n        \"description\": \"Description of the group\",\n        \"members\": [\n            {\n                \"_id\": \"memberId1\",\n                \"name\": \"Member Name\",\n                \"email\": \"member@example.com\"\n            }\n        ],\n        \"createdBy\": {\n            \"_id\": \"creatorId1\",\n            \"name\": \"Creator Name\",\n            \"email\": \"creator@example.com\"\n        },\n        \"status\": \"active\",\n        \"inviteCode\": \"ABC123\",\n        \"createdAt\": \"2023-01-01T00:00:00Z\",\n        \"updatedAt\": \"2023-01-02T00:00:00Z\",\n        \"__v\": 0\n    }\n]\n

Notes

Ensure the server is running and accessible at the specified URL.
The response may contain multiple group objects depending on the data available in the database.

\n","urlObject":{"protocol":"http","port":"5000","path":["api","groups"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"6177b96a-0993-4f36-9cc3-b2f8e45a0eb5","name":"Get my group","originalRequest":{"method":"GET","header":[],"url":"http://localhost:5000/api/groups"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"815"},{"key":"ETag","value":"W/\"32f-KzpheMS7IrZ7caf7NewoRSMDeQM\""},{"key":"Date","value":"Sat, 02 May 2026 08:23:27 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_id\": \"69f5b45518f1be19d2d68ab9\",\n \"name\": \"Office Lunch\",\n \"description\": \"Daily food splits\",\n \"members\": [\n {\n \"_id\": \"69f593ba649b41cd797085dc\",\n \"name\": \"Test User\",\n \"email\": \"test@example.com\"\n }\n ],\n \"createdBy\": {\n \"_id\": \"69f593ba649b41cd797085dc\",\n \"name\": \"Test User\",\n \"email\": \"test@example.com\"\n },\n \"status\": \"active\",\n \"inviteCode\": \"AVCn_m99aN\",\n \"createdAt\": \"2026-05-02T08:22:45.855Z\",\n \"updatedAt\": \"2026-05-02T08:22:45.855Z\",\n \"__v\": 0\n },\n {\n \"_id\": \"69f5a8dc18f1be19d2d68a79\",\n \"name\": \"Office Lunch\",\n \"description\": \"Daily food splits\",\n \"members\": [\n {\n \"_id\": \"69f593ba649b41cd797085dc\",\n \"name\": \"Test User\",\n \"email\": \"test@example.com\"\n }\n ],\n \"createdBy\": {\n \"_id\": \"69f593ba649b41cd797085dc\",\n \"name\": \"Test User\",\n \"email\": \"test@example.com\"\n },\n \"status\": \"active\",\n \"inviteCode\": \"d6i0ot6D6V\",\n \"createdAt\": \"2026-05-02T07:33:48.886Z\",\n \"updatedAt\": \"2026-05-02T07:33:48.886Z\",\n \"__v\": 0\n }\n]"}],"_postman_id":"65b75b0a-b2ed-4da8-8e0b-c768d68d632d"},{"name":"Get group details","id":"209640f7-c243-463e-8fc4-d1159d54acf3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:5000/api/groups/:groupId","description":"

Retrieve Group Details

This endpoint retrieves the details of a specific group identified by its unique groupId.

Request

Method: GET
Endpoint: http://localhost:5000/api/groups/:groupId
Path Parameter:
- groupId (string): The unique identifier of the group whose details are being requested.
\n

Response

On a successful request, the server responds with a status code of 200 and returns a JSON object containing the following fields:

_id (string): The unique identifier of the group.
name (string): The name of the group.
description (string): A brief description of the group.
members (array): A list of members in the group, where each member object contains:
- _id (string): The unique identifier of the member.
- name (string): The name of the member.
- email (string): The email address of the member.
\n
createdBy (object): Information about the creator of the group, containing:
- _id (string): The unique identifier of the creator.
- name (string): The name of the creator.
- email (string): The email address of the creator.
\n
status (string): The current status of the group.
inviteCode (string): The invite code for joining the group.
createdAt (string): The timestamp when the group was created.
updatedAt (string): The timestamp when the group was last updated.
__v (integer): The version key for the group document.

Example Response

{\n  \"_id\": \"\",\n  \"name\": \"\",\n  \"description\": \"\",\n  \"members\": [\n    {\n      \"_id\": \"\",\n      \"name\": \"\",\n      \"email\": \"\"\n    }\n  ],\n  \"createdBy\": {\n    \"_id\": \"\",\n    \"name\": \"\",\n    \"email\": \"\"\n  },\n  \"status\": \"\",\n  \"inviteCode\": \"\",\n  \"createdAt\": \"\",\n  \"updatedAt\": \"\",\n  \"__v\": 0\n}\n

\n","urlObject":{"protocol":"http","port":"5000","path":["api","groups",":groupId"],"host":["localhost"],"query":[],"variable":[{"type":"any","value":"69f5a8dc18f1be19d2d68a79","key":"groupId"}]}},"response":[{"id":"a8b223fa-adc7-47cb-94fb-dd1c5778a23d","name":"Get group details","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://localhost:5000/api/groups/:groupId","protocol":"http","host":["localhost"],"port":"5000","path":["api","groups",":groupId"],"variable":[{"key":"groupId","value":"69f5a8dc18f1be19d2d68a79"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"406"},{"key":"ETag","value":"W/\"196-sq+LvkW6Ka2q6hKGZdkULZY8f6w\""},{"key":"Date","value":"Sat, 02 May 2026 08:24:43 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"69f5a8dc18f1be19d2d68a79\",\n \"name\": \"Office Lunch\",\n \"description\": \"Daily food splits\",\n \"members\": [\n {\n \"_id\": \"69f593ba649b41cd797085dc\",\n \"name\": \"Test User\",\n \"email\": \"test@example.com\"\n }\n ],\n \"createdBy\": {\n \"_id\": \"69f593ba649b41cd797085dc\",\n \"name\": \"Test User\",\n \"email\": \"test@example.com\"\n },\n \"status\": \"active\",\n \"inviteCode\": \"d6i0ot6D6V\",\n \"createdAt\": \"2026-05-02T07:33:48.886Z\",\n \"updatedAt\": \"2026-05-02T07:33:48.886Z\",\n \"__v\": 0\n}"}],"_postman_id":"209640f7-c243-463e-8fc4-d1159d54acf3"}],"id":"3b1c1b6d-3e3a-4a41-95c3-a7a2ed9343d1","description":"

StartFragment

The Group Management module allows users to organize and manage shared expense groups efficiently.

🔹 Features:

Create a Group\n

  Create groups for trips, roommates, or events  \n  \n

Get My Groups\n

  View all groups the user is part of  \n  \n

Get Group Details\n

  Access members, expenses, and balances within a group\n

🎯 Purpose:

To simplify collaboration and organize shared expenses among multiple users.

EndFragment

\n","_postman_id":"3b1c1b6d-3e3a-4a41-95c3-a7a2ed9343d1"},{"name":"Financial Insights","item":[{"name":"Get analytics","id":"70d03acc-28a4-457d-816e-eb2d44bca637","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://localhost:5000/api/insights/user","urlObject":{"protocol":"http","port":"5000","path":["api","insights","user"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"0fc97e41-ca71-46a4-a446-5ea1de1a5ccb","name":"Get analytics","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://localhost:5000/api/insights/user"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"289"},{"key":"ETag","value":"W/\"121-pGRaK5woydnD1OLXA65zNLKmtcc\""},{"key":"Date","value":"Sat, 02 May 2026 08:29:25 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"totalSpending\": 50,\n \"categoryBreakdown\": [\n {\n \"name\": \"Others\",\n \"value\": 50\n }\n ],\n \"monthlyTrend\": [\n {\n \"month\": \"May 26\",\n \"amount\": 50\n }\n ],\n \"groupBreakdown\": [\n {\n \"name\": \"Office Lunch\",\n \"value\": 50\n }\n ],\n \"insights\": [\n \"Your highest spending category is Others (₹50).\",\n \"Your highest spending group is \\\"Office Lunch\\\".\"\n ]\n}"}],"_postman_id":"70d03acc-28a4-457d-816e-eb2d44bca637"}],"id":"09fa909b-9ed9-4162-8e3e-c93b5581ec2b","description":"

StartFragment

The Financial Insights module provides analytical data and smart summaries to help users understand their spending patterns.

🔹 Features:

Get Analytics\n
\n
```
  Visual breakdown of expenses  \n  \n
```
- Spending trends over time
  \n
- Category-wise insights
  \n
\n

🎯 Purpose:

To help users make smarter financial decisions through data-driven insights.

EndFragment

\n","_postman_id":"09fa909b-9ed9-4162-8e3e-c93b5581ec2b"},{"name":"Settlements","item":[{"name":"Group History","id":"0030e994-fa3e-4ec8-8bce-a85f95e19f80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:5000/api/settlements/:groupId","urlObject":{"protocol":"http","port":"5000","path":["api","settlements",":groupId"],"host":["localhost"],"query":[],"variable":[{"type":"any","value":"69f5a8dc18f1be19d2d68a79","key":"groupId"}]}},"response":[{"id":"e92d8c67-6eb1-4a4d-89fa-93c046ee1c28","name":"Group History","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://localhost:5000/api/settlements/:groupId","protocol":"http","host":["localhost"],"port":"5000","path":["api","settlements",":groupId"],"variable":[{"key":"groupId","value":"69f5a8dc18f1be19d2d68a79"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2"},{"key":"ETag","value":"W/\"2-l9Fw4VUO7kr8CvBlt4zaMCqXZ0w\""},{"key":"Date","value":"Sat, 02 May 2026 08:32:20 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"0030e994-fa3e-4ec8-8bce-a85f95e19f80"},{"name":"Recent Payments","id":"769cbfc5-cb75-4073-a748-e04a0e5ff8e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:5000/api/settlements/recent","urlObject":{"protocol":"http","port":"5000","path":["api","settlements","recent"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"e3bc0234-6630-4a22-9a25-310764d8e879","name":"Recent Payments","originalRequest":{"method":"GET","header":[],"url":"http://localhost:5000/api/settlements/recent"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2"},{"key":"ETag","value":"W/\"2-l9Fw4VUO7kr8CvBlt4zaMCqXZ0w\""},{"key":"Date","value":"Sat, 02 May 2026 08:33:26 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"769cbfc5-cb75-4073-a748-e04a0e5ff8e9"}],"id":"990229e7-9b1c-49fd-ba3c-84a30593c219","description":"

StartFragment

The Settlements module helps users clear outstanding balances and maintain accurate records of payments.

🔹 Features:

Group History\n

  View all past settlements within a group  \n  \n

Recent Payments\n

  Track latest settlement transactions\n

🎯 Purpose:

To ensure transparency and simplify the process of settling debts between group members.

EndFragment

\n","_postman_id":"990229e7-9b1c-49fd-ba3c-84a30593c219"},{"name":"CHECK","id":"6dca7168-484e-4570-84b5-d4e4a4541d73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:5000/","description":"

API Request Description

Endpoint

GET http://localhost:5000/

Method

This endpoint uses the HTTP GET method to retrieve data from the server.

Request Parameters

This endpoint does not require any specific request parameters. It is a simple GET request designed to fetch data from the root of the server.

Expected Response Format

Upon a successful request, the server will respond with a JSON object containing the requested data. The structure of the response will depend on the server's implementation but is typically formatted in a standard JSON format.

Example Response

{\n    \"key\": \"value\",\n    \"anotherKey\": \"anotherValue\"\n}\n\n

Make sure to handle the response appropriately in your application to extract the necessary information.

\n","urlObject":{"protocol":"http","port":"5000","path":[""],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"61a54e14-c9ec-4635-b8eb-711c9cdf6372","name":"CHECK","originalRequest":{"method":"GET","header":[],"url":"http://localhost:5000/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Content-Length","value":"32"},{"key":"ETag","value":"W/\"20-HmY//I7/pLhVdL/UwrSJoOfy66w\""},{"key":"Date","value":"Sat, 02 May 2026 06:01:23 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"SplitSmart Pro API is running..."}],"_postman_id":"6dca7168-484e-4570-84b5-d4e4a4541d73"}]}

Get Expenses by Group ID

Request Parameters

Response Structure

Get Recent Expenses

Request

Response

Example Response

🔹 Features:

Add Expense\n

View Expenses\n

Recent Expenses\n

🎯 Purpose:

API Endpoint: Get Balance Summary

Description

Request

Input Parameters

Response

Example Response

Notes

API Endpoint: Get Group Balance

Method

Endpoint

Description

Parameters

Expected Response Format

Example Response

🔹 Features:

User Summary\n

Activity Feed\n

🎯 Purpose:

Signup API

Request

Request Body

Response

Notes

🔹 Features:

Sign-Up\n

Log-In\n

Google Authentication\n

🎯 Purpose:

Create a New Group

Request

Request Body Parameters

Response

Response Fields

Important Notes

API Endpoint: Retrieve Groups

Description

Request Method

Request URL

Response Structure

Example Response

Notes

Retrieve Group Details

Request

Response

Example Response

🔹 Features:

Create a Group\n

Get My Groups\n

Get Group Details\n

🎯 Purpose:

🔹 Features:

Get Analytics\n

🎯 Purpose:

🔹 Features:

Group History\n

Recent Payments\n

🎯 Purpose:

API Request Description

Endpoint

Method

Request Parameters

Expected Response Format

Example Response