Breakdowns provide a detailed summary of the monthly sum of key variables, including Salary, Other Income, Loan Amount, Loan Repayment and more to come. A unique name identifies each variable, and for each variable, there is an array of values containing the date(yyy-mm) and corresponding amount for each month.
Structure
The “Breakdowns” variable is an array of objects, where each object represents a specific variable. Each object has the following structure:
JavaScript
| Code Block |
|---|
{
"name": "VariableName",
"values": [
{
"date": "YYYY-MM",
"amount": NumericValue
},
]
}
|
name: A string representing the name of the variable.
values: An array of objects, each containing the breakdown for a specific month.
date: A string in "YYYY-MM" format representing the month and year of the data.
amount: The numeric value associated with the variable for the given month.
Variables Supported Currently
salary
otherIncome
loan
loanRepayment
JavaScript
| Code Block |
|---|
"breakdowns": [
{
"name": "otherIncome",
"values": [
{
"date": "2023-05",
"amount": 411000
},
{
"date": "2023-06",
"amount": 582500
}
]
},
{
"name": "salary",
"values": [
{
"date": "2023-05",
"amount": 146000
},
{
"date": "2023-06",
"amount": 150000
},
{
"date": "2023-07",
"amount": 150000
},
{
"date": "2023-08",
"amount": 150000
}
]
},
{
"name": "loan",
"values": [
{
"date": "2023-06",
"amount": 230685
}
]
},
{
"name": "loanRepayment",
"values": [
{
"date": "2023-05",
"amount": 17.73
},
{
"date": "2023-06",
"amount": 20688.5
},
{
"date": "2023-07",
"amount": 21813.48
}
]
}
]
|
Statement Accuracy
The StatementAccuracy variable represents the accuracy of various checks performed on a bank statement.
Fields
BalanceAccuracy: This field verifies if the stated balance in the statement precisely matches the actual balance after accounting for all transactions, including debits and credits. It is of type bool.
AirtimeOutlier: This field indicates whether the statement includes an outlier in airtime transactions. An airtime transaction is considered an outlier when its amount exceeds #10,000. It is of type bool. (currently works for only NGN)
TransactionFeeOutlier: This field indicates whether the statement contains an outlier in transaction fees. A transaction labelled as a 'transaction fee' is considered an outlier when its amount exceeds #50. It is of type bool. (currently works for only NGN)
JavaScript
| Code Block |
|---|
"statementAccuracy": {
"checks": {
"balanceAccuracy": false,
"airtimeOutlier": false,
"transactionFeeOutlier": false
}
} |