📈Reports
Generate a summary report for the Business Bank Account Record. The Summary Plus highlights key transaction metrics to give an understanding of the Business's cash flow.
Summary Plus
POST {{baseUrl}}/business/bank-accounts/:bank_account_id/transaction-reports/summaryPlus
Path Parameters
bank_account_id*
String
The UUID for a Business Bank Account that gets generated and returned in either POST Create without Customer or POST Create with Customer response.
Request Body
start_date*
String
This field indicates the start date from which you would like to generate the Summary Plus. 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 Plus. In the following format: "yyyy-mm-dd"
Status Codes
201: Created
Multi Month
{
"bank_account_id": "{{bankAccountId}}",
"account_holder": "THE DIRECTOR *FINCH MBCB (PTY) LTD",
"account_number": "6268237xxxx",
"data": [
{
"id": "8c3c683b-ac46-4ff8-b831-27686b56e059",
"report": {
"months": {
"year": 2022,
"month": "August",
"fullMonth": false,
"lowest_balance": 14055.51,
"lowest_balance_date": "2022-08-24",
"highest_balance": 101454.7,
"highest_balance_date": "2022-08-25",
"incomes": "87399.19",
"number_of_incomes": 3,
"highest_income_type": "income",
"expenses": "98313.63",
"transfers_debit": "20000.00",
"number_of_transfers_debit": 1,
"transfers_credit": "0.00",
"number_of_transfers_credit": 0,
"number_of_expense_transactions": 16,
"debt_repayments": "0.00",
"number_of_debt_repayments": 0
},
"averages": {
"average_incomes": "29133.06",
"average_expenses": "6144.60",
"last_transaction": "31 August",
"first_transaction": "02 August",
"total_average_incomes": "21849.80",
"number_of_transactions": 20,
"total_average_expenses": "24578.41",
"average_debt_repayments": 0,
"total_average_debt_repayments": 0
}
},
"start_date": "2022-08-02",
"end_date": "2022-08-31",
"type": "summaryPlus",
"statement_opening_balance": 35900.65,
"statement_closing_balance": 24986.21
},
{
"id": "4661c3ab-43bf-4ac0-9357-02dc5046a8a6",
"report": {
"months": {
"year": 2022,
"month": "September",
"fullMonth": false,
"lowest_balance": 10273.81,
"lowest_balance_date": "2022-09-29",
"highest_balance": 94987.91,
"highest_balance_date": "2022-09-26",
"incomes": "87399.19",
"number_of_incomes": 3,
"highest_income_type": "income",
"expenses": "102111.59",
"transfers_debit": "0.00",
"number_of_transfers_debit": 0,
"transfers_credit": "0.00",
"number_of_transfers_credit": 0,
"number_of_expense_transactions": 24,
"debt_repayments": "0.00",
"number_of_debt_repayments": 0
},
"averages": {
"average_incomes": "29133.06",
"average_expenses": "4254.65",
"last_transaction": "29 September",
"first_transaction": "01 September",
"total_average_incomes": "21849.80",
"number_of_transactions": 27,
"total_average_expenses": "25527.90",
"average_debt_repayments": 0,
"total_average_debt_repayments": 0
}
},
"start_date": "2022-09-01",
"end_date": "2022-09-29",
"type": "summaryPlus",
"statement_opening_balance": 24980.21,
"statement_closing_balance": 10273.81
},
{
"id": "aea12e7a-789b-4f9d-8bb3-101f6b79c449",
"report": {
"months": {
"year": 2022,
"month": "October",
"fullMonth": false,
"lowest_balance": 2449.03,
"lowest_balance_date": "2022-10-11",
"highest_balance": 78814.42,
"highest_balance_date": "2022-10-20",
"incomes": "87399.19",
"number_of_incomes": 3,
"highest_income_type": "income",
"expenses": "85971.84",
"transfers_debit": "0.00",
"number_of_transfers_debit": 0,
"transfers_credit": "0.00",
"number_of_transfers_credit": 0,
"number_of_expense_transactions": 18,
"debt_repayments": "0.00",
"number_of_debt_repayments": 0
},
"averages": {
"average_incomes": "29133.06",
"average_expenses": "4776.21",
"last_transaction": "29 October",
"first_transaction": "01 October",
"total_average_incomes": "21849.80",
"number_of_transactions": 21,
"total_average_expenses": "21492.96",
"average_debt_repayments": 0,
"total_average_debt_repayments": 0
}
},
"start_date": "2022-10-01",
"end_date": "2022-10-29",
"type": "summaryPlus",
"statement_opening_balance": 9893.81,
"statement_closing_balance": 11701.16
},
{
"id": "7964b420-5d30-42e7-bbd9-ca0dad73a75d",
"report": {
"months": {
"year": 2022,
"month": "November",
"fullMonth": false,
"lowest_balance": 1092.1,
"lowest_balance_date": "2022-11-09",
"highest_balance": 88491.29,
"highest_balance_date": "2022-11-25",
"incomes": "87399.19",
"number_of_incomes": 3,
"highest_income_type": "income",
"expenses": "70740.01",
"transfers_debit": "0.00",
"number_of_transfers_debit": 0,
"transfers_credit": "0.00",
"number_of_transfers_credit": 0,
"number_of_expense_transactions": 15,
"debt_repayments": "0.00",
"number_of_debt_repayments": 0
},
"averages": {
"average_incomes": "29133.06",
"average_expenses": "4716.00",
"last_transaction": "29 November",
"first_transaction": "01 November",
"total_average_incomes": "21849.80",
"number_of_transactions": 18,
"total_average_expenses": "17685.00",
"average_debt_repayments": 0,
"total_average_debt_repayments": 0
}
},
"start_date": "2022-11-01",
"end_date": "2022-11-29",
"type": "summaryPlus",
"statement_opening_balance": 11162.88,
"statement_closing_balance": 28360.34
},
{
"id": "e6660bb3-1e8b-480f-8e37-8a2f4cbc7c6f",
"report": {
"months": {
"year": 2022,
"month": "December",
"fullMonth": false,
"lowest_balance": 16258.37,
"lowest_balance_date": "2022-12-12",
"highest_balance": 92623.76,
"highest_balance_date": "2022-12-15",
"incomes": "87399.19",
"number_of_incomes": 3,
"highest_income_type": "income",
"expenses": "62768.06",
"transfers_debit": "7000.00",
"number_of_transfers_debit": 1,
"transfers_credit": "0.00",
"number_of_transfers_credit": 0,
"number_of_expense_transactions": 9,
"debt_repayments": "0.00",
"number_of_debt_repayments": 0
},
"averages": {
"average_incomes": "29133.06",
"average_expenses": "6974.23",
"last_transaction": "29 December",
"first_transaction": "05 December",
"total_average_incomes": "21849.80",
"number_of_transactions": 13,
"total_average_expenses": "15692.02",
"average_debt_repayments": 0,
"total_average_debt_repayments": 0
}
},
"start_date": "2022-12-05",
"end_date": "2022-12-29",
"type": "summaryPlus",
"statement_opening_balance": 28348.73,
"statement_closing_balance": 45991.47
}
]
}Response Variable Descriptions
id
Unique monthly transactions statement ID
year
The year recorded on the bank statement transactions
fullMonth
Whether the transaction period covers the full duration of the month recorded or not
lowest_balance
The smallest (minimum) account balance during the transaction period
lowest_balance_date
The date when the lowest balance occurred
highest_balance
The largest (maximum) account balance during the transaction period
highest_balance_date
The date when the highest balance occurred
incomes
Sum amount of all credits within that transaction period
number_of_incomes
The total number (count) of credit transactions within that transaction period
highest_income_type
The category/type of the credit with the highest amount
expenses
Sum amount of all expenses within that transaction period
transfers_debit
The total amount of funds transferred out (sent to another account) within that transaction period
number_of_transfers_debit
The total number (count) of debit transfers transactions within that transaction period
transfers_credit
The total amount of funds transferred in (received from another account) within that transaction period
number_of_transfers_credit
The total number (count) of credit transfers transactions within that transaction period
number_of_expense_transactions
The total number (count) of expense transactions within that transaction period
debt_repayments
Sum amount of all debt repayments made within that transaction period
number_of_debt_repayments
The total number (count) of debt repayments within that transaction period
average_incomes
Sum of all credit amounts divided by the number of credit transactions within that transaction period (expenses/number_of_expenses)
average_expenses
Sum of all expense amounts divided by the number of expense transactions within that transaction period (expenses/number_of_expenses)
last_transaction
Date of the last transaction within that transaction period
first_transaction
Date of the first transaction within that transaction period
total_average_incomes
The cumulative average income over multiple periods (total credits within that transaction period/number of full months within the statement upload)
number_of_transactions
The total number of transactions within that transaction period
total_average_expenses
The cumulative average expenses over multiple periods (total expenses within that transaction period/number of full months within the statement upload)
average_debt_repayments
The sum amount of all debt repayment transactions divided by the number (count) of debt repayment transactions within that transaction period (debt_repayments/number_of_debt_repayments)
total_average_debt_repayments
The cumulative average expenses over multiple periods (total expenses within that transaction period/number of full months within the statement upload)
start_date
The start date of the transaction period
end_date
The end date of the transaction period
statement_opening_balance
The account balance at the start of the statement period
statement_closing _balance
The account balance at the end of the statement period
Last updated
Was this helpful?