Transaction Summary

GET

/desktop/transactions/summary

This endpoint retrieves a summary of desktop transactions within a specified date range. The HTTP GET request should be made to {{BASE_URL}}/desktop/transactions/summary with the 'startDate' and 'endDate' query parameters. The response will have a status code of 200 and a content type of 'application/json'. The response body will include a 'success' boolean field, a 'message' string field, and a 'data' object containing 'moneyIn' and 'moneyOut' fields, which represent the total money in and money out for the specified date range.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

Responses

🟢200Transaction Summary

application/json

Body

🟢200Transaction Summary

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Transaction Summary - Transaction Summary

{
    "success": true,
    "message": "Business transaction summary fetched successfully!",
    "data": {
        "moneyIn": "₦1,079,651.25",
        "moneyOut": "₦347,000.00",
        "unFormatedMoneyIn": 1079651.25,
        "unFormattedMoneyOut": 347000,
        "averageSaleValue": "₦6,426.50",
        "percentageChange": 642550,
        "summary": {
            "getMoneyInSummary": {
                "totalSales": "₦1,079,651.25",
                "totalDiscounts": "₦6,975.00",
                "totalDelivery": "₦0.00",
                "totalTax": "₦59,951.25",
                "totalUnpaidBalance": "₦3,495,825.00",
                "totalMoneyIn": "-₦2,483,100.00",
                "profit": "-₦3,562,751.25"
            },
            "getMoneyOutSummary": {
                "totalExpenses": "₦942,000.00",
                "totalUnpaidBalance": "₦595,000.00",
                "totalMoneyOut": "₦347,000.00"
            },
            "balance": "₦732,651.25",
            "generalSummary": {
                "moneyInCount": "168",
                "moneyOutCount": "53",
                "transactionCount": 221
            }
        }
    }
}

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

Search Tranasctions

Debtors Summary