Log Support Ticket

💶Summary Plus

Generate a summary of total values, number of transactions per transaction category, averages and rolling averages for incomes, expenses and debt repayments for a period of time.

Summary Plus

POST {{baseUrl}}/bank-accounts/:bank_account_id/transaction-reports/summaryPlus

Generate a report with a summary of total values, number of transaction categories and monthly averages for incomes, expenses and debt repayments over a given period. Plus a rolling 3-month averages for all transaction categories, as well as main_income_transaction and dates.

Path Parameters

NameTypeDescription

bank_account_id*

String

This is UUID for a Bank Account that gets generated and returned in the POST Create new Bank Account response.

Request Body

NameTypeDescription

start_date*

String

This field indicates the start date from which you would like to generate the summary report. In the following format: "yyyy-mm-dd"

end_date*

String

This field indicates the end date up until which you would like to generate the summary report. In the following format: "yyyy-mm-dd"

{
    "data": [
        {
            "id": "34c3d29b-75d0-46fc-811c-e3287ae10c54",
            "report": {
                "months": {
                    "year": 2023,
                    "month": "February",
                    "incomes": "36479.28",
                    "expenses": "73603.18",
                    "fullMonth": true,
                    "main_income": "36159.28",
                    "debt_repayments": "4157.47",
                    "main_income_date": "24-02-23",
                    "main_income_type": "salary-wages",
                    "number_of_incomes": 4,
                    "main_income_transaction": "FNB OB Pmt Salary 62563981",
                    "number_of_debt_repayments": 1,
                    "number_of_expense_transactions": 91
                },
                "averages": {
                    "average_incomes": "9119.82",
                    "average_expenses": "808.83",
                    "last_transaction": "28 February",
                    "first_transaction": "01 February",
                    "total_average_incomes": "12159.76",
                    "number_of_transactions": 96,
                    "total_average_expenses": "24534.39",
                    "average_debt_repayments": "4157.47",
                    "total_average_debt_repayments": "1385.82"
                }
            },
            "start_date": "2023-02-01",
            "end_date": "2023-02-28",
            "type": "summaryPlus"
        },
        {
            "id": "0c8abd73-c7c4-4e98-9ffb-74b741c7b23e",
            "report": {
                "months": {
                    "year": 2023,
                    "month": "March",
                    "incomes": "52105.21",
                    "expenses": "81201.07",
                    "fullMonth": true,
                    "main_income": "46785.21",
                    "debt_repayments": "4157.47",
                    "main_income_date": "25-03-23",
                    "main_income_type": "salary-wages",
                    "number_of_incomes": 11,
                    "main_income_transaction": "FNB OB Pmt Salary 62563981",
                    "number_of_debt_repayments": 1,
                    "number_of_expense_transactions": 71
                },
                "averages": {
                    "average_incomes": "4736.84",
                    "average_expenses": "1143.68",
                    "last_transaction": "31 March",
                    "first_transaction": "01 March",
                    "total_average_incomes": "17368.40",
                    "number_of_transactions": 83,
                    "total_average_expenses": "27067.02",
                    "average_debt_repayments": "4157.47",
                    "total_average_debt_repayments": "1385.82"
                }
            },
            "start_date": "2023-03-01",
            "end_date": "2023-03-31",
            "type": "summaryPlus"
        }
    ]
}

Last updated