Get Budget Summary

GET

/desktop/budgets/summary

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200Budget Summary

application/json

Body

🟢200Budget Summary

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/desktop/budgets/summary?criteria=this_month' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Budget Summary - Budget Summary

{
    "success": true,
    "message": "Budgets summary fetched successfully!",
    "data": {
        "budgetSummary": [
            {
                "categoryId": "8",
                "categoryTitle": "Salaries & Wages",
                "totalBudget": 170000,
                "formattedTotalBudget": "₦ 170,000.00",
                "totalSpent": 0,
                "formattedTotalSpent": "₦ 0.00",
                "remainingAmount": 170000,
                "formattedRemainingAmount": "₦ 170,000.00"
            },
            {
                "categoryId": "10",
                "categoryTitle": "Rent",
                "totalBudget": 10000,
                "formattedTotalBudget": "₦ 10,000.00",
                "totalSpent": 0,
                "formattedTotalSpent": "₦ 0.00",
                "remainingAmount": 10000,
                "formattedRemainingAmount": "₦ 10,000.00"
            },
            {
                "categoryId": "11",
                "categoryTitle": "Savings",
                "totalBudget": 45000,
                "formattedTotalBudget": "₦ 45,000.00",
                "totalSpent": 0,
                "formattedTotalSpent": "₦ 0.00",
                "remainingAmount": 45000,
                "formattedRemainingAmount": "₦ 45,000.00"
            },
            {
                "categoryId": "12",
                "categoryTitle": "Transport",
                "totalBudget": 50000,
                "formattedTotalBudget": "₦ 50,000.00",
                "totalSpent": 0,
                "formattedTotalSpent": "₦ 0.00",
                "remainingAmount": 50000,
                "formattedRemainingAmount": "₦ 50,000.00"
            }
        ],
        "totalBudget": 275000,
        "formattedTotalBudget": "₦ 275,000.00",
        "totalSpent": 0,
        "formattedTotalSpent": "₦ 0.00",
        "totalRemaining": 275000,
        "formattedTotalRemaining": "₦ 275,000.00"
    }
}

Modified at 2025-09-01 22:54:16

Bulk Delete Budgets

Get All Budgets