get https://sandbox.onebrick.io/v1/transaction-balance-summary
This API furnishes the data on monthly basics and helps you get the Beginning balance, Ending balance, Daily balance, Average balance, Income source, and expenses destination.
Request Parameters
Key Parameter | Data Type | Description |
---|---|---|
user_access_token | String | token generated after successful institution connection through the widget which needs to be passed as the Bearer token in the Authorization header |
from | String | Starting date Form date(format - MM-YYYY) |
to | String | End date till you want a data(format - MM-YYYY) |
Response parameters
Key Parameter | Data type | Description |
---|---|---|
institution_id | Integar | Institution identification number |
accountId | String | Account Identification number from end-user's financial account |
beginningBalance | Float | Balance on the first day of each month |
avgBalance | Float | Balance at the end of each day and divides it by the number of calendar days |
endingBalance | Float | Balance on the last day of each month |
month | String | Return Historical Balance based on this month |
year | String | Returns Historical Balance based on this year |
daily_balance | Float | Balance on the each day in one month |
total_income | Float | Total amount of money received in one month |
credit_transaction | Float | Total inbound transaction in one month |
total_expense | Float | Total amount of money sent in one month |
debit_transaction | Float | Total outbound transaction in one month |
top_income - source | String | Source of income received by the user |
top_income - frequency | Float | Total inbound transaction received by the user from the particular source |
top_income - total_amount | Float | Total amount of money received by the user from the particular source |
top_expense - source | String | Destination of outbound transaction done by the user |
top_expense - frequency | Float | Total outbound transaction done by the user to the particular source |
top_expense - total_amount | Float | Total amount of money sent by the user to the particular source |