A Expense Sharing Application API.Used to Share Expese between users / friends based on Share Basis : EQUAL, EXACT, PERCENT.
Run the following Commands to install the Dependencies
composer install
npm installthis will return your access token for your rest of the requests
POST /api/login BODY [form-data] : Email , Password
RETURN FORMAT :
{
"access_token": "xxxxxxxxxxxxxxxxxxxxxx", //access token
"token_type": "Bearer"
}
This is used to insert Expense and Shares in Database. You will have to Send your Authorization token in Header and Return Format will be JSON.
POST api/expense/add_expense HEADERS :
Authorization : Bearer xxxxxxxxxxxxxxxxxxxxxx
Content-Type : application/json
Accept : application/json
xxxxxxxxxxxxxxxxxxxxxx is your ACCESS TOKEN.
BODY [JSON] : // Three Formats EQUAL, EXACT, PERCENT
EQUAL SHARE JSON :
{
"name" : "Travel",
"amount" : 1200,
"share_type": "EQUAL",
"shares" : [
{
"friend_ids" : [2,3,4]
}
]
}
EXACT SHARE JSON :
{
"name" : "Shopping",
"amount" : 1000,
"share_type": "EXACT",
"shares" : [
{
"friend_id" : 2,
"share_amount" : 200
},
{
"friend_id" : 3,
"share_amount" : 200
},
{
"friend_id" : 4,
"share_amount" : 600
}
]
}
----
PERCENT SHARE JSON :
{
"name" : "Grocery",
"amount" : 1000,
"share_type": "PERCENT",
"shares" : [
{
"friend_id" : 2,
"share_percent" : 20
},
{
"friend_id" : 3,
"share_percent" : 30
},
{
"friend_id" : 4,
"share_percent" : 50
}
]
}
RETURN FORMAT :
{
"success": true,
"msg": "Expense Has been Stored"
}
This will Return Sum of All Expenses Made by Authenticated user and Also Balances array which contains sum of Money each users owes Authenticated User.
GET api/expense/get_expenses HEADERS :
Authorization : Bearer xxxxxxxxxxxxxxxxxxxxxx
Content-Type : application/json
Accept : application/json
RETURN FORMAT :
{
"total_expenses": "3200.00",
"balances": [
"User2 Owes User1 a Total of 800",
"User3 Owes User1 a Total of 900",
"User4 Owes User1 a Total of 1500"
],
"details": [
{
"friend": "User2",
"friend_id": 2,
"email": "[email protected]",
"balance": 800
},
{
"friend": "User3",
"friend_id": 3,
"email": "[email protected]",
"balance": 900
},
{
"friend": "User4",
"friend_id": 4,
"email": "[email protected]",
"balance": 1500
}
]
}
