Introduction
This document should be read in conjunction with the main API Section of the Documentation. That section provides some general information about using the API, and how to submit and request data in various formats.
This document describes the changes introduced in each version of the API that is available for BankStatements.
API Versions
The API is versioned, so that changes and updates to the API do not cause compatibility issues with existing integrations. The API version is determined by the number in the API URL. The current version is v1
.
Backwards compatible changes to the API may be introduced to an API version over time, such as adding new endpoints or optional fields to existing endpoints etc. These changes will be announced and documented in order to allow existing clients to be able to take advantage of newer API functionality.
It is possible to interact with specific versions of API functions by using the custom HTTP header X-OUTPUT-VERSION
, which requires a value of a date in the format yyyymmdd
(i.e. 20160527
). This allows integration with a specific version of an API function. When this HTTP header is not provided, then the base API function will be used as a default. This means that newer functionality and/or response formats must be explicitly requested.
Currently available version values are as follows
Version String | Description | Details |
---|---|---|
<blank> | The original version. | Details |
20160527 | Simplifies and standardises the raw data format. A complete re-write from the original version. | Details |
20170401 | A minor update from the previous version. Makes Analysis Points more consistent, and allows for Decision Metrics which provide key metrics across all accounts. | Details |
20190901 | This version allows multiple accounts from multiple banks to be present together in a single statement. There were some additional changes to the individual bank statement sections to improve consistency between the json and xml formats. | Details |
Original Version
Example Data Response, for
Original
version:
{
"accounts": {
"bank_of_statements": {
"accounts": [
{
"accountHolder": "Mary Jones",
"name": "Transaction Account",
"accountNumber": "456789",
"id": 0,
"bsb": "123-456",
"balance": "123.45",
"available": "123.45",
"statementData": {
"details": [
{
"dateObj": {
"date": "2017-05-05 00:00:00.000000",
"timezone_type": 3,
"timezone": "Australia/Adelaide"
},
"date": "05-05-2017",
"text": "Interest - current rate is 1.05%",
"notes": null,
"amount": 0,
"type": "Credit",
"balance": "123.45",
"tags": [
"Income"
]
},
{
"dateObj": {
"date": "2017-05-05 00:00:00.000000",
"timezone_type": 3,
"timezone": "Australia/Adelaide"
},
"date": "05-05-2017",
"text": "Wage from delivery service job",
"notes": null,
"amount": 26.58,
"type": "Credit",
"balance": "123.45",
"tags": [
"Income"
]
}
],
"totalCredits": "8276.06",
"totalDebits": "-6628.79",
"openingBalance": "-1523.82",
"closingBalance": "123.45",
"startDate": "08-02-2017",
"endDate": "10-05-2017",
"minBalance": "-3599.56",
"maxBalance": "795.51",
"dayEndBalances": [
{
"date": "2017-05-10",
"balance": "123.45"
},
{
"date": "2017-05-09",
"balance": "123.45"
}
],
"minDayEndBalance": "-3599.56",
"maxDayEndBalance": "795.51",
"daysInNegative": 75,
"errorMessage": "",
"analysis": {
"Income": {
"total": {
"transactionCount": 4,
"totalValue": 581.32,
"monthAvg": 191.64395604396
},
"Wages": {
"transactionCount": 3,
"totalValue": 581.32,
"monthAvg": 191.64395604396,
"minValue": "26.58",
"maxValue": "346.20",
"firstTransaction": "05-05-2017",
"lastTransaction": "23-03-2017",
"period": 20,
"periodIsRegular": false,
"transactions": [
{
"dateObj": {
"date": "2017-05-05 00:00:00.000000",
"timezone_type": 3,
"timezone": "Australia/Adelaide"
},
"date": "05-05-2017",
"text": "Wage from delivery service job",
"notes": null,
"amount": 26.58,
"type": "Credit",
"balance": "123.45",
"tags": [
"Income"
]
}
]
}
}
}
},
"institution": "Bank of Statements",
"accountType": "transaction"
}
]
}
},
"user_token": "9f1l4sv1ngocl3n5tphk6s2712"
}
<?xml version="1.0" encoding="utf-8"?>
<xml>
<accounts>
<bank_of_statements>
<accounts>
<account>
<accountHolder>Mary Jones</accountHolder>
<name>Transaction Account</name>
<accountNumber>456789</accountNumber>
<id>0</id>
<bsb>123-456</bsb>
<balance>123.45</balance>
<available>123.45</available>
<statementData>
<details>
<detail>
<dateObj>
<date>2017-05-05 00:00:00.000000</date>
<timezone_type>3</timezone_type>
<timezone>Australia/Adelaide</timezone>
</dateObj>
<date>05-05-2017</date>
<text>Interest - current rate is 1.05%</text>
<notes></notes>
<amount>0</amount>
<type>Credit</type>
<balance>123.45</balance>
<tags>
<tag key="0">Income</tag>
</tags>
</detail>
<detail>
<dateObj>
<date>2017-05-05 00:00:00.000000</date>
<timezone_type>3</timezone_type>
<timezone>Australia/Adelaide</timezone>
</dateObj>
<date>05-05-2017</date>
<text>Wage from delivery service job</text>
<notes></notes>
<amount>26.58</amount>
<type>Credit</type>
<balance>123.45</balance>
<tags>
<tag key="0">Income</tag>
</tags>
</detail>
</details>
<totalCredits>8276.06</totalCredits>
<totalDebits>-6628.79</totalDebits>
<openingBalance>-1523.82</openingBalance>
<closingBalance>123.45</closingBalance>
<startDate>08-02-2017</startDate>
<endDate>10-05-2017</endDate>
<minBalance>-3599.56</minBalance>
<maxBalance>795.51</maxBalance>
<dayEndBalances>
<dayEndBalance>
<date>2017-05-10</date>
<balance>123.45</balance>
</dayEndBalance>
<dayEndBalance>
<date>2017-05-09</date>
<balance>123.45</balance>
</dayEndBalance>
</dayEndBalances>
<minDayEndBalance>-3599.56</minDayEndBalance>
<maxDayEndBalance>795.51</maxDayEndBalance>
<daysInNegative>75</daysInNegative>
<errorMessage></errorMessage>
<analysis>
<Income>
<total>
<transactionCount>4</transactionCount>
<totalValue>581.32</totalValue>
<monthAvg>191.64395604396</monthAvg>
</total>
<Wages>
<transactionCount>3</transactionCount>
<totalValue>581.32</totalValue>
<monthAvg>191.64395604396</monthAvg>
<minValue>26.58</minValue>
<maxValue>346.20</maxValue>
<firstTransaction>05-05-2017</firstTransaction>
<lastTransaction>23-03-2017</lastTransaction>
<period>20</period>
<periodIsRegular>0</periodIsRegular>
<transactions>
<transaction>
<dateObj>
<date>2017-05-05 00:00:00.000000</date>
<timezone_type>3</timezone_type>
<timezone>Australia/Adelaide</timezone>
</dateObj>
<date>05-05-2017</date>
<text>Wage from delivery service job</text>
<notes></notes>
<amount>26.58</amount>
<type>Credit</type>
<balance>123.45</balance>
<tags>
<tag key="0">Income</tag>
</tags>
</transaction>
</transactions>
</Wages>
</analysis>
</statementData>
<institution>Bank of Statements</institution>
<accountType>transaction</accountType>
</account>
</accounts>
</bank_of_statements>
</accounts>
<user_token>ggq3hmaahb7nlrff8iahpc5hb0</user_token>
</xml>
This is the original raw data version of the data retrieved from a customer’s bank account via the BankStatements API. It includes some metadata information about the retrieval itself, the customer’s bank and bank account details, the transactions for each account retreived, and some basic categorisation.
20160527 Version
Example Data Response, for version ‘20160527’:
{
"reference": "",
"submissionTime": "2017-05-11T15:28:00",
"bankData": {
"bankName": "Bank of Statements",
"bankSlug": "bank_of_statements",
"bankAccounts": [
{
"id": 0,
"accountType": "transaction",
"accountHolder": "Mary Jones",
"accountName": "Transaction Account",
"bsb": "123-456",
"accountNumber": "456789",
"currentBalance": "123.45",
"availableBalance": "123.45",
"transactions": [
{
"date": "2017-05-09",
"text": "Interest - current rate is 1.05%",
"amount": 0,
"type": "Informational",
"balance": "123.45",
"tags": [
{
"category": "Information"
},
{
"creditDebit": "credit"
}
]
},
{
"date": "2017-05-05",
"text": "Wage from delivery service job",
"amount": 447.94,
"type": "",
"balance": "528.34",
"tags": [
{
"thirdParty": "Wages"
},
{
"category": "Wages"
},
{
"creditDebit": "credit"
}
]
}
],
"statementSummary": {
"openingBalance": "-790.39",
"totalCredits": "7564.28",
"totalDebits": "-6650.44",
"closingBalance": "123.45",
"minBalance": "-1726.81",
"minDayEndBalance": "-1726.81",
"daysInNegative": 84,
"searchPeriodStart": "2017-02-08",
"searchPeriodEnd": "2017-05-10",
"transactionsStartDate": "2017-02-09",
"transactionsEndDate": "2017-05-09"
},
"dayEndBalances": [
{
"date": "2017-05-10",
"balance": "123.45"
},
{
"date": "2017-05-09",
"balance": "123.45"
}
],
"additionalDetails": {
"interestRate": "",
"accountAddress": {
"text": ""
}
},
"statementAnalysis": [
{
"analysisCategory": {
"name": "Wages",
"analysisPoints": [
{
"name": "totalAmountPaid",
"value": 694.39
}
],
"transactionGroups": [
{
"name": "Wage from delivery service job",
"analysisPoints": [
{
"name": "Start Date",
"value": "23 Apr"
},
{
"name": "End Date",
"value": "05 May"
},
{
"name": "Total Pay",
"value": "$694.39"
},
{
"name": "Frequency",
"value": "6 days "
},
{
"name": "Frequency Day",
"value": "Sun"
},
{
"name": "Number of pays",
"value": 3
},
{
"name": "Last 30 Days Pay",
"value": "$694.39"
},
{
"name": "Monthly Average",
"value": "$173.6"
},
{
"name": "Avg Pay",
"value": "$231.46"
}
],
"transactions": [
{
"date": "2017-05-05",
"text": "Wage from delivery service job",
"amount": 447.94,
"type": "",
"balance": "528.34",
"tags": [
{
"thirdParty": "Wages"
},
{
"category": "Wages"
},
{
"creditDebit": "credit"
}
]
},
{
"date": "2017-04-25",
"text": "Wage from delivery service job",
"amount": 118.2,
"type": "",
"balance": "-822.51",
"tags": [
{
"thirdParty": "Wages"
},
{
"category": "Wages"
},
{
"creditDebit": "credit"
}
]
}
]
}
]
}
}
]
}
],
"userAddress": {
"text": ""
}
},
"user_token": "vupic1r8dikcer3gs4g28bmas1"
}
<?xml version="1.0" encoding="utf-8"?>
<provisoReport>
<reference></reference>
<submissionTime>2017-05-11T15:30:00</submissionTime>
<bankData>
<bankName>Bank of Statements</bankName>
<bankSlug>bank_of_statements</bankSlug>
<bankAccounts>
<bankAccount>
<id>0</id>
<accountType>transaction</accountType>
<accountHolder>Mary Jones</accountHolder>
<accountName>Transaction Account</accountName>
<bsb>123-456</bsb>
<accountNumber>456789</accountNumber>
<currentBalance>123.45</currentBalance>
<availableBalance>123.45</availableBalance>
<transactions>
<transaction>
<date>2017-05-09</date>
<description>Interest - current rate is 1.05%</description>
<amount>0.00</amount>
<balance>123.45</balance>
<type>Informational</type>
<tags>
<tag name="category">Information</tag>
<tag name="creditDebit">credit</tag>
<tag name="category">Information</tag>
</tags>
</transaction>
<transaction>
<date>2017-05-09</date>
<description>Debit Excess Interest</description>
<amount>-404.89</amount>
<balance>123.45</balance>
<type>Overdrawn Fees</type>
<tags>
<tag name="category">Overdrawn</tag>
<tag name="creditDebit">debit</tag>
<tag name="category">Overdrawn</tag>
</tags>
</transaction>
</transactions>
<statementSummary>
<openingBalance>-790.39</openingBalance>
<totalCredits>7564.28</totalCredits>
<totalDebits>-6650.44</totalDebits>
<closingBalance>123.45</closingBalance>
<minBalance>-1726.81</minBalance>
<minDayEndBalance>-1726.81</minDayEndBalance>
<daysInNegative>84</daysInNegative>
<searchPeriodStart>2017-02-08</searchPeriodStart>
<searchPeriodEnd>2017-05-10</searchPeriodEnd>
<transactionsStartDate>2017-02-09</transactionsStartDate>
<transactionsEndDate>2017-05-09</transactionsEndDate>
<dayEndBalances>
<dayEndBalance>
<date>2017-05-10</date>
<balance>123.45</balance>
</dayEndBalance>
<dayEndBalance>
<date>2017-05-09</date>
<balance>123.45</balance>
</dayEndBalance>
</dayEndBalances>
<statementAnalysis>
<analysisCategory name="Wages">
<analysisPoints>
<analysisPoint name="totalAmountPaid" dataType="money">694.39</analysisPoint>
</analysisPoints>
<transactionGroups>
<transactionGroup name="Wage from delivery service job">
<analysisPoints>
<analysisPoint name="startDate" dataType="date">2017-04-23</analysisPoint>
<analysisPoint name="endDate" dataType="date">2017-05-05</analysisPoint>
<analysisPoint name="totalAmountPaid" dataType="money">694.39</analysisPoint>
<analysisPoint name="frequency" dataType="double">6</analysisPoint>
<analysisPoint name="frequencyDay" dataType="string">Sun</analysisPoint>
<analysisPoint name="numberOfPays" dataType="integer">3</analysisPoint>
<analysisPoint name="last30DaysPay" dataType="money">694.39</analysisPoint>
<analysisPoint name="monthlyAverage" dataType="money">173.6</analysisPoint>
<analysisPoint name="avgPay" dataType="money">231.46</analysisPoint>
</analysisPoints>
<transactions>
<transaction>
<date>2017-05-05</date>
<description>Wage from delivery service job</description>
<amount>447.94</amount>
<balance>528.34</balance>
<type/>
<tags>
<tag name="thirdParty">Wages</tag>
<tag name="category">Wages</tag>
<tag name="creditDebit">credit</tag>
<tag name="thirdParty">Wages</tag>
<tag name="category">Wages</tag>
</tags>
</transaction>
<transaction>
<date>2017-04-25</date>
<description>Wage from delivery service job</description>
<amount>118.20</amount>
<balance>-822.51</balance>
<type/>
<tags>
<tag name="thirdParty">Wages</tag>
<tag name="category">Wages</tag>
<tag name="creditDebit">credit</tag>
<tag name="thirdParty">Wages</tag>
<tag name="category">Wages</tag>
</tags>
</transaction>
</transactions>
</transactionGroup>
</transactionGroups>
</analysisCategory>
</statementAnalysis>
</statementSummary>
<additionalDetails>
<interestRate/>
<address>
<text/>
<streetLine/>
<levelNumber/>
<levelType/>
<buildingName/>
<unitNumber/>
<unitType/>
<streetNumber/>
<streetName/>
<streetType/>
<streetSuffix/>
<suburb/>
<state/>
<stateCode/>
<postcode/>
<country/>
<countryCode/>
</address>
</additionalDetails>
</bankAccount>
</bankAccounts>
<address>
<text/>
<streetLine/>
<levelNumber/>
<levelType/>
<buildingName/>
<unitNumber/>
<unitType/>
<streetNumber/>
<streetName/>
<streetType/>
<streetSuffix/>
<suburb/>
<state/>
<stateCode/>
<postcode/>
<country/>
<countryCode/>
</address>
</bankData>
<user_token>vupic1r8dikcer3gs4g28bmas1</user_token>
</provisoReport>
This version is a substantial change from the previous version in regards to formatting, in an attempt to make the data more consistent. This version is the result of an improvement in the underlying BankStatements categorisation engine which was made more flexible to be able to produce statement data for clients that contain the specific categories of data that they require, rather than simply containing all the available categories.
Changes:
- Improve the hierarchy of the data to reflect the visual appearance of html/pdf statement versions, and produce more consistency between statements from different banks.
- Add in some additional metadata like the
submissionTime
andaddress
. - Improve the date format used in
transactions
. - Include more data such as the
statementSummary
andanalysisPoints
fortransactionGroups
within ananalysisCateogry
. - Ensure that the statement doesn’t output un-necessary categories that don’t have any associated transactions, thereby decreasing the size of the data returned by the API.
- Allow the categories used in the statement’s categorisation process to be configured on a per client basis, rather than all clients using all categories as per the previous version of the statement data.
20170401 Version
Example Data Response, for version ‘20170401’:
{
"dataVersion": 20170401,
"reference": "TEST",
"submissionTime": "2017-05-08T17:44:00",
"bankData": {
"bankName": "Bank of Statements",
"bankSlug": "bank_of_statements",
"bankAccounts": [
{
"id": 0,
"accountType": "transaction",
"accountHolderType": "single",
"accountHolder": "Mary Jones",
"accountName": "Transaction Account",
"bsb": "123-456",
"accountNumber": "456789",
"currentBalance": "123.45",
"availableBalance": "123.45",
"transactions": [
{
"date": "2017-05-05",
"text": "Wage from delivery service job",
"amount": 409.73,
"type": "",
"balance": "371.24",
"tags": [
{
"thirdParty": "Wages"
},
{
"category": "Wages"
},
{
"creditDebit": "credit"
}
]
},
{
"date": "2017-05-05",
"text": "Wage from delivery service job",
"amount": 93.84,
"type": "",
"balance": "-38.49",
"tags": [
{
"thirdParty": "Wages"
},
{
"category": "Wages"
},
{
"creditDebit": "credit"
}
]
}
],
"statementSummary": {
"openingBalance": "-7474.80",
"totalCredits": "49541.44",
"totalDebits": "-41943.19",
"closingBalance": "123.45",
"minBalance": "-8430.71",
"minDayEndBalance": "-8133.41",
"daysInNegative": 88,
"searchPeriodStart": "2017-02-06",
"searchPeriodEnd": "2017-05-07",
"transactionsStartDate": "2017-02-06",
"transactionsEndDate": "2017-05-06"
},
"dayEndBalances": [
{
"date": "2017-05-07",
"balance": "123.45"
},
{
"date": "2017-05-06",
"balance": "123.45"
}
],
"additionalDetails": {
"interestRate": "",
"accountAddress": {
"text": "2 Smith St Sefton Park SA 5083 AUSTRALIA",
"streetLine": "2 Smith St",
"streetNumber": "2",
"streetName": "Smith",
"streetType": "Street",
"suburb": "Sefton Park",
"stateCode": "SA",
"state": "South Australia",
"postcode": "5083",
"countryCode": "au"
}
},
"statementAnalysis": [
{
"analysisCategory": {
"name": "Wages",
"analysisPoints": [
{
"name": "startDate",
"value": "2017-02-07",
"title": "Start Date",
"type": "date"
},
{
"name": "endDate",
"value": "2017-05-05",
"title": "End Date",
"type": "date"
},
{
"name": "totalAmount",
"value": 4563.3,
"title": "Total Amount",
"type": "money"
},
{
"name": "countOfTransactions",
"value": 18,
"title": "Count of Transactions",
"type": "integer"
},
{
"name": "totalAmountLast30Days",
"value": 1155.97,
"title": "Total Amount - Last 30 Days",
"type": "money"
},
{
"name": "monthlyAmountAverage",
"value": 1480.99,
"title": "Monthly Average Amount",
"type": "money"
},
{
"name": "averageTransactionAmount",
"value": 253.52,
"title": "Average Transaction Amount",
"type": "money"
},
{
"name": "daysSinceLastTransaction",
"value": 3,
"title": "Days Since Last Transaction",
"type": "integer"
},
{
"name": "totalAmountCredits",
"value": 4563.3,
"title": "Total Amount - Credits",
"type": "money"
},
{
"name": "totalAmountDebits",
"value": 0,
"title": "Total Amount - Debits",
"type": "money"
},
{
"name": "countOfProviders",
"value": 1,
"title": "Count of Providers",
"type": "integer"
}
],
"transactionGroups": [
{
"name": "Wage from delivery service job",
"analysisPoints": [
{
"name": "startDate",
"value": "2017-02-07",
"title": "Start Date",
"type": "date"
},
{
"name": "endDate",
"value": "2017-05-05",
"title": "End Date",
"type": "date"
},
{
"name": "totalAmount",
"value": 4563.3,
"title": "Total Amount",
"type": "money"
},
{
"name": "frequency",
"value": 6,
"title": "Frequency",
"type": "integer"
},
{
"name": "frequencyDay",
"value": "Fri",
"title": "Frequency Day",
"type": "string"
},
{
"name": "countOfTransactions",
"value": 18,
"title": "Count of Transactions",
"type": "integer"
},
{
"name": "totalAmountLast30Days",
"value": 1155.97,
"title": "Total Amount - Last 30 Days",
"type": "money"
},
{
"name": "monthlyAmountAverage",
"value": 1480.99,
"title": "Monthly Average Amount",
"type": "money"
},
{
"name": "averageTransactionAmount",
"value": 253.52,
"title": "Average Transaction Amount",
"type": "money"
},
{
"name": "daysSinceLastTransaction",
"value": 3,
"title": "Days Since Last Transaction",
"type": "integer"
},
{
"name": "totalAmountCredits",
"value": 4563.3,
"title": "Total Amount - Credits",
"type": "money"
},
{
"name": "totalAmountDebits",
"value": 0,
"title": "Total Amount - Debits",
"type": "money"
}
],
"transactions": [
{
"date": "2017-05-05",
"text": "Wage from delivery service job",
"amount": 409.73,
"type": "",
"balance": "371.24",
"tags": [
{
"thirdParty": "Wages"
},
{
"category": "Wages"
},
{
"creditDebit": "credit"
}
]
},
{
"date": "2017-05-05",
"text": "Wage from delivery service job",
"amount": 93.84,
"type": "",
"balance": "-38.49",
"tags": [
{
"thirdParty": "Wages"
},
{
"category": "Wages"
},
{
"creditDebit": "credit"
}
]
}
]
}
]
}
}
]
}
],
"userAddress": {
"text": "2 Smith St Sefton Park SA 5083 AUSTRALIA",
"streetLine": "2 Smith St",
"streetNumber": "2",
"streetName": "Smith",
"streetType": "Street",
"suburb": "Sefton Park",
"stateCode": "SA",
"state": "South Australia",
"postcode": "5083",
"countryCode": "au"
}
},
"decisionMetrics": [
{
"id": "DM001",
"name": "Wages - Monthly",
"descriptor": "",
"type": "money",
"value": "6469.24"
},
{
"id": "DM002",
"name": "Centrelink - Monthly",
"descriptor": "",
"type": "money",
"value": "5891.46"
},
{
"id": "DM003",
"name": "Centrelink as a Percentage of Total Income",
"descriptor": "",
"type": "percentage",
"value": "47.66"
},
{
"id": "DM004",
"name": "Number of Dishonours",
"descriptor": "",
"type": "integer",
"value": 134
},
{
"id": "DM005",
"name": "Number of SACC Dishonours",
"descriptor": "",
"type": "integer",
"value": 70
},
{
"id": "DM006",
"name": "Percentage of Income Spent on Day of Deposit ",
"descriptor": "",
"type": "percentage",
"value": "346.60"
},
{
"id": "DM007",
"name": "Gambling - Monthly",
"descriptor": "",
"type": "money",
"value": "2617.56"
},
{
"id": "DM008",
"name": "Expected Pay Date for Largest Income Source",
"descriptor": "",
"type": "string",
"value": "Past (29-04-2017)"
},
{
"id": "DM009",
"name": "SACC Loans Funded - Statement Period",
"descriptor": "",
"type": "money",
"value": "21418.45"
},
{
"id": "DM010",
"name": "SACC Loan Repayments - Last 30 Days",
"descriptor": "",
"type": "money",
"value": "6170.98"
},
{
"id": "DM011",
"name": "SACC Repayments for Ongoing Loans - Predicted Next 30 Days",
"descriptor": "",
"type": "money",
"value": "839.83"
},
{
"id": "DM012",
"name": "Number of SACC Providers",
"descriptor": "",
"type": "integer",
"value": 4
},
{
"id": "DM013",
"name": "Living Expenses - Monthly ",
"descriptor": "",
"type": "money",
"value": "14899.00"
},
{
"id": "DM014",
"name": "Collection and Consolidation - Monthly",
"descriptor": "",
"type": "money",
"value": "3945.78"
},
{
"id": "DM015",
"name": "Credit Card Repayments - Monthly",
"descriptor": "",
"type": "money",
"value": "2034.00"
},
{
"id": "DM016",
"name": "Other Credits - Monthly",
"descriptor": "",
"type": "money",
"value": "16646.18"
}
],
"user_token": "ggq3hmaahb7nlrff8iahpc5hb0"
}
<?xml version="1.0" encoding="utf-8"?>
<provisoReport dataVersion="20170401">
<reference>TEST</reference>
<submissionTime>2017-05-08T16:58:00</submissionTime>
<bankData>
<bankName>Bank of Statements</bankName>
<bankSlug>bank_of_statements</bankSlug>
<bankAccounts>
<bankAccount>
<id>0</id>
<accountType>transaction</accountType>
<accountHolder>Mary Jones</accountHolder>
<accountHolderType>single</accountHolderType>
<accountName>Transaction Account</accountName>
<bsb>123-456</bsb>
<accountNumber>456789</accountNumber>
<currentBalance>123.45</currentBalance>
<availableBalance>123.45</availableBalance>
<transactions>
<transaction>
<date>2017-05-05</date>
<description>Wage from delivery service job</description>
<amount>409.73</amount>
<balance>371.24</balance>
<type/>
<tags>
<tag name="thirdParty">Wages</tag>
<tag name="category">Wages</tag>
<tag name="creditDebit">credit</tag>
</tags>
</transaction>
<transaction>
<date>2017-05-05</date>
<description>Wage from delivery service job</description>
<amount>93.84</amount>
<balance>-38.49</balance>
<type/>
<tags>
<tag name="thirdParty">Wages</tag>
<tag name="category">Wages</tag>
<tag name="creditDebit">credit</tag>
</tags>
</transaction>
</transactions>
<statementSummary>
<openingBalance>-7474.80</openingBalance>
<totalCredits>49541.44</totalCredits>
<totalDebits>-41943.19</totalDebits>
<closingBalance>123.45</closingBalance>
<minBalance>-8430.71</minBalance>
<minDayEndBalance>-8133.41</minDayEndBalance>
<daysInNegative>88</daysInNegative>
<searchPeriodStart>2017-02-06</searchPeriodStart>
<searchPeriodEnd>2017-05-07</searchPeriodEnd>
<transactionsStartDate>2017-02-06</transactionsStartDate>
<transactionsEndDate>2017-05-06</transactionsEndDate>
<dayEndBalances>
<dayEndBalance>
<date>2017-05-07</date>
<balance>123.45</balance>
</dayEndBalance>
<dayEndBalance>
<date>2017-05-06</date>
<balance>123.45</balance>
</dayEndBalance>
</dayEndBalances>
<statementAnalysis>
<analysisCategory name="Wages">
<analysisPoints>
<analysisPoint dataType="date" name="startDate" title="Start Date">2017-02-06</analysisPoint>
<analysisPoint dataType="date" name="endDate" title="End Date">2017-05-06</analysisPoint>
<analysisPoint dataType="money" name="totalAmount" title="Total Amount">7588.04</analysisPoint>
<analysisPoint dataType="integer" name="countOfTransactions" title="Count of Transactions">24</analysisPoint>
<analysisPoint dataType="money" name="totalAmountLast30Days" title="Total Amount - Last 30 Days">2499.63</analysisPoint>
<analysisPoint dataType="money" name="monthlyAmountAverage" title="Monthly Average Amount">2429.88</analysisPoint>
<analysisPoint dataType="money" name="averageTransactionAmount" title="Average Transaction Amount">316.17</analysisPoint>
<analysisPoint dataType="integer" name="daysSinceLastTransaction" title="Days Since Last Transaction">2</analysisPoint>
<analysisPoint dataType="money" name="totalAmountCredits" title="Total Amount - Credits">7588.04</analysisPoint>
<analysisPoint dataType="money" name="totalAmountDebits" title="Total Amount - Debits">0</analysisPoint>
<analysisPoint dataType="integer" name="countOfProviders" title="Count of Providers">1</analysisPoint>
</analysisPoints>
<transactionGroups>
<transactionGroup name="Wage from delivery service job">
<analysisPoints>
<analysisPoint dataType="date" name="startDate" title="Start Date">2017-02-06</analysisPoint>
<analysisPoint dataType="date" name="endDate" title="End Date">2017-05-06</analysisPoint>
<analysisPoint dataType="money" name="totalAmount" title="Total Amount">7588.04</analysisPoint>
<analysisPoint dataType="integer" name="frequency" title="Frequency">4</analysisPoint>
<analysisPoint dataType="string" name="frequencyDay" title="Frequency Day">Fri</analysisPoint>
<analysisPoint dataType="integer" name="countOfTransactions" title="Count of Transactions">24</analysisPoint>
<analysisPoint dataType="money" name="totalAmountLast30Days" title="Total Amount - Last 30 Days">2499.63</analysisPoint>
<analysisPoint dataType="money" name="monthlyAmountAverage" title="Monthly Average Amount">2429.88</analysisPoint>
<analysisPoint dataType="money" name="averageTransactionAmount" title="Average Transaction Amount">316.17</analysisPoint>
<analysisPoint dataType="integer" name="daysSinceLastTransaction" title="Days Since Last Transaction">2</analysisPoint>
<analysisPoint dataType="money" name="totalAmountCredits" title="Total Amount - Credits">7588.04</analysisPoint>
<analysisPoint dataType="money" name="totalAmountDebits" title="Total Amount - Debits">0</analysisPoint>
</analysisPoints>
<transactions>
<transaction>
<date>2017-05-05</date>
<description>Wage from delivery service job</description>
<amount>409.73</amount>
<balance>371.24</balance>
<type/>
<tags>
<tag name="thirdParty">Wages</tag>
<tag name="category">Wages</tag>
<tag name="creditDebit">credit</tag>
</tags>
</transaction>
<transaction>
<date>2017-05-05</date>
<description>Wage from delivery service job</description>
<amount>93.84</amount>
<balance>-38.49</balance>
<type/>
<tags>
<tag name="thirdParty">Wages</tag>
<tag name="category">Wages</tag>
<tag name="creditDebit">credit</tag>
</tags>
</transaction>
</transactions>
</transactionGroup>
</transactionGroups>
</analysisCategory>
</statementAnalysis>
</statementSummary>
<additionalDetails>
<interestRate/>
<address>
<text>2 Smith St Sefton Park SA 5083 AUSTRALIA</text>
<streetLine>2 Smith St</streetLine>
<levelNumber/>
<levelType/>
<buildingName/>
<unitNumber/>
<unitType/>
<streetNumber>2</streetNumber>
<streetName>Smith</streetName>
<streetType>Street</streetType>
<streetSuffix/>
<suburb>Sefton Park</suburb>
<state>South Australia</state>
<stateCode>SA</stateCode>
<postcode>5083</postcode>
<country/>
<countryCode>au</countryCode>
</address>
</additionalDetails>
</bankAccount>
</bankAccounts>
<address>
<text>2 Smith St Sefton Park SA 5083 AUSTRALIA</text>
<streetLine>2 Smith St</streetLine>
<levelNumber/>
<levelType/>
<buildingName/>
<unitNumber/>
<unitType/>
<streetNumber>2</streetNumber>
<streetName>Smith</streetName>
<streetType>Street</streetType>
<streetSuffix/>
<suburb>Sefton Park</suburb>
<state>South Australia</state>
<stateCode>SA</stateCode>
<postcode>5083</postcode>
<country/>
<countryCode>au</countryCode>
</address>
</bankData>
<decisionMetrics>
<decisionMetric descriptor="" id="DM001" name="Wages - Monthly" type="money">6808.55</decisionMetric>
<decisionMetric descriptor="" id="DM002" name="Centrelink - Monthly" type="money">6330.44</decisionMetric>
<decisionMetric descriptor="" id="DM003" name="Centrelink as a Percentage of Total Income" type="percentage">48.18</decisionMetric>
<decisionMetric descriptor="" id="DM004" name="Number of Dishonours" type="integer">143</decisionMetric>
<decisionMetric descriptor="" id="DM005" name="Number of SACC Dishonours" type="integer">67</decisionMetric>
<decisionMetric descriptor="" id="DM006" name="Percentage of Income Spent on Day of Deposit " type="percentage">331.64</decisionMetric>
<decisionMetric descriptor="" id="DM007" name="Gambling - Monthly" type="money">1561.13</decisionMetric>
<decisionMetric descriptor="" id="DM008" name="Expected Pay Date for Largest Income Source" type="date">2017-05-10</decisionMetric>
<decisionMetric descriptor="" id="DM009" name="SACC Loans Funded - Statement Period" type="money">18152.03</decisionMetric>
<decisionMetric descriptor="" id="DM010" name="SACC Loan Repayments - Last 30 Days" type="money">9119.02</decisionMetric>
<decisionMetric descriptor="" id="DM011" name="SACC Repayments for Ongoing Loans - Predicted Next 30 Days" type="money">1256.91</decisionMetric>
<decisionMetric descriptor="" id="DM012" name="Number of SACC Providers" type="integer">4</decisionMetric>
<decisionMetric descriptor="" id="DM013" name="Living Expenses - Monthly " type="money">16410.21</decisionMetric>
<decisionMetric descriptor="" id="DM014" name="Collection and Consolidation - Monthly" type="money">4076.32</decisionMetric>
<decisionMetric descriptor="" id="DM015" name="Credit Card Repayments - Monthly" type="money">2231.73</decisionMetric>
<decisionMetric descriptor="" id="DM016" name="Other Credits - Monthly" type="money">18508.29</decisionMetric>
</decisionMetrics>
<user_token>ggq3hmaahb7nlrff8iahpc5hb0</user_token>
</provisoReport>
This version is a minor update that introduces Decision Metrics (i.e. the decisionMetrics
element that provide key metrics across all accounts) and improves the consistency of the names and appearance of Analysis Points (i.e. analysisPoints
).
Changes:
- It includes
decisionMetrics
element that are key metric data points, calculated from across all the retrieved bank accounts. - The names, data types and values of
analysisPoints
are more consistent, and now include a display title. - More
analysisPoints
have been added (in particular to the loan related categories), in thetransactionGroup
level, and improvements to the calculations of the values to make them more correct for certain edge cases. - Combine
analysisPoints
fortransactionGroups
that belong to acategoryGroup
and display the combined value at theanalysisCategory
level. - Remove duplicate
tags
that would occasionally appear fortransactions
associated with multiple categories. - The example statement format displayed in this documentation also includes example Centrelink data. This Centrelink data would only be present in the statement if the customer’s Centrelink data was retrieved as part of the bank account retrieval process.
- The root element
provisoReport
will now include adataVersion
attribute that will confirm the version of the response that the API is providing.
20190901 Version
Example Data Response, for version ‘20190901’:
{
"dataVersion": 20190901,
"reference": "TEST",
"submissionTime": "2020-04-27T09:27:00",
"banks": [
{
"bankName": "Bank of Statements",
"bankSlug": "bank_of_statements",
"errors": [],
"bankAccounts": [
{
"id": 0,
"accountType": "transaction",
"accountHolder": "Mary Jones",
"accountHolderType": "single",
"accountName": "Transaction Account",
"bsb": "123-456",
"accountNumber": "456789",
"currentBalance": "410.73",
"availableBalance": "410.73",
"transactions": [
{
"date": "2020-04-27",
"description": "Wage from delivery service job",
"amount": 409.73,
"balance": "410.73",
"type": "",
"tags": [
{
"thirdParty": "Wages"
},
{
"category": "Wages"
},
{
"creditDebit": "credit"
}
]
},
{
"date": "2020-04-26",
"description": "Interest - current rate is 1.05%",
"amount": 0,
"balance": "1.00",
"type": "Informational",
"tags": [
{
"category": "Information"
},
{
"creditDebit": "credit"
}
]
}
],
"statementSummary": {
"openingBalance": "977.82",
"totalCredits": "5277.74",
"totalDebits": "-6132.11",
"closingBalance": "410.73",
"minBalance": "-40.78",
"minDayEndBalance": "-40.78",
"daysInNegative": 2,
"searchPeriodStart": "2020-01-27",
"searchPeriodEnd": "2020-04-27",
"transactionsStartDate": "2020-01-27",
"transactionsEndDate": "2020-04-27",
"dayEndBalances": [
{
"date": "2020-04-27",
"balance": "123.45"
},
{
"date": "2020-04-26",
"balance": "463.16"
}
]
},
"statementAnalysis": [
{
"analysisCategory": {
"name": "Wages",
"analysisPoints": [
{
"name": "startDate",
"value": "2020-01-28",
"title": "Start Date",
"type": "date"
},
{
"name": "endDate",
"value": "2020-04-04",
"title": "End Date",
"type": "date"
},
{
"name": "totalAmount",
"value": 1096.85,
"title": "Total Amount",
"type": "money"
},
{
"name": "countOfTransactions",
"value": 5,
"title": "Count of Transactions",
"type": "integer"
},
{
"name": "totalAmountLast30Days",
"value": 476.36,
"title": "Total Amount - Last 30 Days",
"type": "money"
},
{
"name": "monthlyAmountAverage",
"value": 392.91,
"title": "Monthly Average Amount",
"type": "money"
},
{
"name": "averageTransactionAmount",
"value": 219.37,
"title": "Average Transaction Amount",
"type": "money"
},
{
"name": "daysSinceLastTransaction",
"value": 23,
"title": "Days Since Last Transaction",
"type": "integer"
},
{
"name": "totalAmountCredits",
"value": 1096.85,
"title": "Total Amount - Credits",
"type": "money"
},
{
"name": "totalAmountDebits",
"value": 0,
"title": "Total Amount - Debits",
"type": "money"
},
{
"name": "countOfProviders",
"value": 1,
"title": "Count of Providers",
"type": "integer"
}
],
"transactionGroups": [
{
"name": "Wage from delivery service job",
"analysisPoints": [
{
"name": "startDate",
"value": "2020-01-28",
"title": "Start Date",
"type": "date"
},
{
"name": "endDate",
"value": "2020-04-04",
"title": "End Date",
"type": "date"
},
{
"name": "totalAmount",
"value": 1096.85,
"title": "Total Amount",
"type": "money"
},
{
"name": "frequency",
"value": 17,
"title": "Frequency",
"type": "integer"
},
{
"name": "frequencyDay",
"value": "Wed",
"title": "Frequency Day",
"type": "string"
},
{
"name": "countOfTransactions",
"value": 5,
"title": "Count of Transactions",
"type": "integer"
},
{
"name": "totalAmountLast30Days",
"value": 476.36,
"title": "Total Amount - Last 30 Days",
"type": "money"
},
{
"name": "monthlyAmountAverage",
"value": 392.91,
"title": "Monthly Average Amount",
"type": "money"
},
{
"name": "averageTransactionAmount",
"value": 219.37,
"title": "Average Transaction Amount",
"type": "money"
},
{
"name": "daysSinceLastTransaction",
"value": 23,
"title": "Days Since Last Transaction",
"type": "integer"
},
{
"name": "totalAmountCredits",
"value": 1096.85,
"title": "Total Amount - Credits",
"type": "money"
},
{
"name": "totalAmountDebits",
"value": 0,
"title": "Total Amount - Debits",
"type": "money"
}
],
"transactions": [
{
"date": "2020-04-04",
"description": "Wage from delivery service job",
"amount": 409.73,
"balance": "410.73",
"type": "",
"tags": [
{
"thirdParty": "Wages"
},
{
"category": "Wages"
},
{
"creditDebit": "credit"
}
]
}
]
}
]
}
}
],
"additionalDetails": {
"interestRate": "",
"address": {
"text": "LEVEL 3,Unit 6,11 NORTH TCE,KENT TOWN,SA,5067",
"streetLine": "LEVEL 3 Unit 6 11 NORTH TCE",
"levelNumber": "3",
"levelType": "Level",
"buildingName": "",
"unitNumber": "6",
"unitType": "Unit",
"streetNumber": "11",
"streetName": "NORTH",
"streetType": "Terrace",
"streetSuffix": "",
"suburb": "Kent town",
"state": "South Australia",
"stateCode": "SA",
"postcode": "5067",
"country": "",
"countryCode": "au"
}
}
}
],
"address": {
"text": "LEVEL 3,Unit 6,11 NORTH TCE,KENT TOWN,SA,5067",
"streetLine": "LEVEL 3 Unit 6 11 NORTH TCE",
"levelNumber": "3",
"levelType": "Level",
"buildingName": "",
"unitNumber": "6",
"unitType": "Unit",
"streetNumber": "11",
"streetName": "NORTH",
"streetType": "Terrace",
"streetSuffix": "",
"suburb": "Kent town",
"state": "South Australia",
"stateCode": "SA",
"postcode": "5067",
"country": "",
"countryCode": "au"
}
}
],
"decisionMetrics": [],
"user_token": "ggq3hmaahb7nlrff8iahpc5hb0"
}
<?xml version="1.0" encoding="utf-8"?>
<provisoReport dataVersion="20190901">
<reference>TEST</reference>
<submissionTime>2020-04-27T13:28:00</submissionTime>
<banks>
<bankData>
<bankName>Bank of Statements</bankName>
<bankSlug>bank_of_statements</bankSlug>
<errors/>
<bankAccounts>
<bankAccount>
<id>0</id>
<accountType>transaction</accountType>
<accountHolder>Mary Jones</accountHolder>
<accountHolderType>single</accountHolderType>
<accountName>Transaction Account</accountName>
<bsb>123-456</bsb>
<accountNumber>456789</accountNumber>
<currentBalance>410.73</currentBalance>
<availableBalance>410.73</availableBalance>
<transactions>
<transaction>
<date>2020-04-27</date>
<description>Wage from delivery service job</description>
<amount>409.73</amount>
<balance>410.73</balance>
<type/>
<tags>
<tag name="thirdParty">Wages</tag>
<tag name="category">Wages</tag>
<tag name="creditDebit">credit</tag>
</tags>
<transactionHash>2b1311aae3353876bd1ee67f30aba80b7a20b588</transactionHash>
</transaction>
<transaction>
<date>2020-04-26</date>
<description>Interest - current rate is 1.05%</description>
<amount>0.00</amount>
<balance>1.00</balance>
<type>Informational</type>
<tags>
<tag name="category">Information</tag>
<tag name="creditDebit">credit</tag>
</tags>
<transactionHash>69c58c46bf408191293b94bc209a7f8484b4a890</transactionHash>
</transaction>
</transactions>
<statementSummary>
<openingBalance>-853.33</openingBalance>
<totalCredits>27941.77</totalCredits>
<totalDebits>-26964.99</totalDebits>
<closingBalance>410.73</closingBalance>
<minBalance>-3209.11</minBalance>
<minDayEndBalance>-3209.11</minDayEndBalance>
<daysInNegative>221</daysInNegative>
<searchPeriodStart>2019-04-27</searchPeriodStart>
<searchPeriodEnd>2020-04-26</searchPeriodEnd>
<transactionsStartDate>2019-04-27</transactionsStartDate>
<transactionsEndDate>2020-04-27</transactionsEndDate>
<dayEndBalances>
<dayEndBalance>
<date>2020-04-27</date>
<balance>410.73</balance>
</dayEndBalance>
<dayEndBalance>
<date>2020-04-26</date>
<balance>1.00</balance>
</dayEndBalance>
</dayEndBalances>
</statementSummary>
<statementAnalysis>
<analysisCategory name="Wages">
<analysisPoints>
<analysisPoint dataType="date" name="startDate" title="Start Date">2019-05-02</analysisPoint>
<analysisPoint dataType="date" name="endDate" title="End Date">2020-04-16</analysisPoint>
<analysisPoint dataType="money" name="totalAmount" title="Total Amount">3064.71</analysisPoint>
<analysisPoint dataType="integer" name="countOfTransactions" title="Count of Transactions">13</analysisPoint>
<analysisPoint dataType="money" name="totalAmountLast30Days" title="Total Amount - Last 30 Days">427.1</analysisPoint>
<analysisPoint dataType="money" name="monthlyAmountAverage" title="Monthly Average Amount">242.48</analysisPoint>
<analysisPoint dataType="money" name="averageTransactionAmount" title="Average Transaction Amount">235.75</analysisPoint>
<analysisPoint dataType="integer" name="daysSinceLastTransaction" title="Days Since Last Transaction">11</analysisPoint>
<analysisPoint dataType="money" name="totalAmountCredits" title="Total Amount - Credits">3064.71</analysisPoint>
<analysisPoint dataType="money" name="totalAmountDebits" title="Total Amount - Debits">0</analysisPoint>
<analysisPoint dataType="integer" name="countOfProviders" title="Count of Providers">1</analysisPoint>
</analysisPoints>
<transactionGroups>
<transactionGroup name="Wage from delivery service job">
<analysisPoints>
<analysisPoint dataType="date" name="startDate" title="Start Date">2019-05-02</analysisPoint>
<analysisPoint dataType="date" name="endDate" title="End Date">2020-04-16</analysisPoint>
<analysisPoint dataType="money" name="totalAmount" title="Total Amount">3064.71</analysisPoint>
<analysisPoint dataType="integer" name="frequency" title="Frequency">30</analysisPoint>
<analysisPoint dataType="string" name="frequencyDay" title="Frequency Day">Thu</analysisPoint>
<analysisPoint dataType="integer" name="countOfTransactions" title="Count of Transactions">13</analysisPoint>
<analysisPoint dataType="money" name="totalAmountLast30Days" title="Total Amount - Last 30 Days">427.1</analysisPoint>
<analysisPoint dataType="money" name="monthlyAmountAverage" title="Monthly Average Amount">242.48</analysisPoint>
<analysisPoint dataType="money" name="averageTransactionAmount" title="Average Transaction Amount">235.75</analysisPoint>
<analysisPoint dataType="integer" name="daysSinceLastTransaction" title="Days Since Last Transaction">11</analysisPoint>
<analysisPoint dataType="money" name="totalAmountCredits" title="Total Amount - Credits">3064.71</analysisPoint>
<analysisPoint dataType="money" name="totalAmountDebits" title="Total Amount - Debits">0</analysisPoint>
</analysisPoints>
<transactions>
<transaction>
<date>2020-04-16</date>
<description>Wage from delivery service job</description>
<amount>409.73</amount>
<balance>410.73</balance>
<type/>
<tags>
<tag name="thirdParty">Wages</tag>
<tag name="category">Wages</tag>
<tag name="creditDebit">credit</tag>
</tags>
<transactionHash>2b1311aae3353876bd1ee67f30aba80b7a20b588</transactionHash>
</transaction>
</transactions>
</transactionGroup>
</transactionGroups>
</analysisCategory>
</statementAnalysis>
<additionalDetails>
<interestRate/>
<email>XXXXXXXX@gmail.com</email>
<openDate>2016-12-22</openDate>
<phone>XXXX XXX 123</phone>
<address>
<text>LEVEL 3,Unit 6,11 NORTH TCE,KENT TOWN,SA,5067</text>
<streetLine>LEVEL 3 Unit 6 11 NORTH TCE</streetLine>
<levelNumber>3</levelNumber>
<levelType>Level</levelType>
<buildingName/>
<unitNumber>6</unitNumber>
<unitType>Unit</unitType>
<streetNumber>11</streetNumber>
<streetName>NORTH</streetName>
<streetType>Terrace</streetType>
<streetSuffix/>
<suburb>Kent town</suburb>
<state>South Australia</state>
<stateCode>SA</stateCode>
<postcode>5067</postcode>
<country/>
<countryCode>au</countryCode>
</address>
</additionalDetails>
</bankAccount>
</bankAccounts>
<address>
<text>LEVEL 3,Unit 6,11 NORTH TCE,KENT TOWN,SA,5067</text>
<streetLine>LEVEL 3 Unit 6 11 NORTH TCE</streetLine>
<levelNumber>3</levelNumber>
<levelType>Level</levelType>
<buildingName/>
<unitNumber>6</unitNumber>
<unitType>Unit</unitType>
<streetNumber>11</streetNumber>
<streetName>NORTH</streetName>
<streetType>Terrace</streetType>
<streetSuffix/>
<suburb>Kent town</suburb>
<state>South Australia</state>
<stateCode>SA</stateCode>
<postcode>5067</postcode>
<country/>
<countryCode>au</countryCode>
</address>
</bankData>
</banks>
<decisionMetrics>
<decisionMetric descriptor="" id="DM103" name="Child Support Income - Monthly" type="money">0.00</decisionMetric>
<decisionMetric descriptor="" id="DM104" name="Child Support Payments - Monthly" type="money">0.00</decisionMetric>
<decisionMetric descriptor="" id="DM107" name="ATM Credits - Monthly" type="money">0.00</decisionMetric>
<decisionMetric descriptor="" id="DM108" name="ATM Debits - Monthly" type="money">0.00</decisionMetric>
<decisionMetric descriptor="" id="DM017" name="ATM - Monthly" type="money">0.00</decisionMetric>
<decisionMetric descriptor="" id="DM018" name="Debt Collection - Monthly" type="money">0.00</decisionMetric>
<decisionMetric descriptor="" id="DM070" name="Child Support - Monthly" type="money">0.00</decisionMetric>
<decisionMetric descriptor="" id="DM105" name="Superannuation Credits - Monthly" type="money">0.00</decisionMetric>
<decisionMetric descriptor="" id="DM106" name="Superannuation Debits - Monthly" type="money">0.00</decisionMetric>
<decisionMetric descriptor="" id="DM109" name="Credit Card Repayments (Debits Only) - Monthly" type="money">0.00</decisionMetric>
<decisionMetric descriptor="" id="DM007" name="Gambling Expenditure - Monthly" type="money">168.90</decisionMetric>
<decisionMetric descriptor="" id="DM020" name="Dishonours - Monthly" type="money">0.00</decisionMetric>
<decisionMetric descriptor="" id="DM038" name="Benefits - Monthly" type="money">233.01</decisionMetric>
<decisionMetric descriptor="" id="DM073" name="Average Day End Balance (Wage Income Day)" type="money">352.44</decisionMetric>
<decisionMetric descriptor="" id="TY001" name="Benefits - Monthly" type="money">233.01</decisionMetric>
<decisionMetric descriptor="" id="DM001" name="Wages - Monthly" type="money">242.48</decisionMetric>
<decisionMetric descriptor="" id="DM039" name="Direct Debits - Monthly" type="money">124.44</decisionMetric>
</decisionMetrics>
<user_token>ggq3hmaahb7nlrff8iahpc5hb0</user_token>
</provisoReport>
This version includes a change that allows multiple accounts from multiple banks to be present together in a single statement. Some additional changes to the individual bank statement sections have been made to improve consistency between the json and xml formats.
Changes:
- A root-level element
banks
has been included to allow bank data from multiple banking institutions to be present in a single document. - The “address” elements have been modified to ensure that there is consistency with the sub-elements that are output. If the sub-element has no data then the value will be an empty string, rather than omitting the sub-element entirely.
- Changes to improve consistency between the JSON and XML versions:
- JSON version changes:
- The
text
element oftransaction
has been renamed asdescription
. - The
dayEndBalances
element has been moved to be a child element ofstatementSummary
(previously it was a sibling element). - The position of
additionalDetails
was changed to appear after it’s siblingstatementAnalysis
, rather than before it.
- The
- XML version changes:
- The element
statementAnalysis
was moved to be a sibling ofstatementSummary
(instead of being a child element).
- The element
- JSON version changes: