Affordability

type

Value of this resource is "affordability"

id

The identifier of the affordability resource to be retrieved.

fromMonth

Start month for the period for which the Affordability summary is generated. The period of time relates to the account and transaction data used as input into the report.

toMonth

End month (usually the current month) for the period for which the Affordability summary is generated.

coverageDays

Number of days included in the report period.

generatedDate

Date the report was generated. e.g. "2018-09-12T00:59:28"

assets

Total of cash based assets

liabilities

Total of account based liabilities split into credit and loan liabilities

netPosition

Total assets minus total liabilities

creditLimit

Total credit limit across all credit cards and overdrafts

regularIncome

Provides an average of monthly - avgMonthly regular income calculated over the previous 3 month period previous3Months.

For example:
"regularIncome": {
"previous3Months": {
"avgMonthly": "5000.00"
}
}

expenses

Provides an average of monthly expenses calculated for the whole period of data retrieved (e.g. 13 months)

savings

Average of monthly savings calculated for the whole period of data retrieved (e.g. 13 months)

type

Value of this resource is "account"

currency

The currency in which the account is recorded.

balance

The balance at the time of the query.

availableFunds

The available funds at the time of the query.

account

Identifies the type and product of the account:

• type (values as defined in class object Account Type in Accounts

• product (as defined by the institution)

institution

The name of the financial institution with whom the account is held.

previous6months

Includes minimum and maximum balances recorded in the account of the queried period.

• minBalance

• maxBalance

currency

The currency in which the account is recorded.

balance

The balance at the time of the query.

availableFunds

The available funds at the time of the query.

account

Identifies the type and product of the account:

• type (values as defined in class object Account Type in Accounts

• product (as defined by the institution)

institution

The name of the financial institution with whom the account is held.

previousMonth

A summary of the credit facility activity of the previous month, consisting of:

• totalCredits

• totalDebits

• minBalance

• maxBalance

previous6months

Acknowledges any cash advances made in the previous 6 months:

• cashAdvances - value of cash advances in period

creditLimit

Total credit limit available for the specified credit facility.

currency

The currency in which the account is recorded.

balance

The balance at the time of the query.

availableFunds

The available funds at the time of the query.

account

Identifies the type and product of the account:

• type (values as defined in class object Account Type in Accounts

• product (as defined by the institution)

institution

The name of the financial institution with whom the account is held.

previousMonth

A summary of the credit facility activity of the previous month, consisting of:

• totalCredits

• totalDebits

• totalInterestCharged

• totalRepayments

changeHistory

• direction - debit or credit

• amount - amount loan-interest or loan-repayment

• date - date e.g. "2019-03-15T17:00:00"

• source - cleaned transaction description

previous6months

Acknowledges if the account is in repayment arrears:

• arrears - has the loan been in arrears in the past 6 months - returned as a string value (true or false or null)

source

Source of external payment (cleaned transaction description).

payments

Aggregated attributes relating to payments for this source (identified as an external)

• first - date of first payment e.g. "2019-03-15"

• last - date of last payment e.g. "2020-03-15"

• noOccurrences - number of occurrences for same source (in this group)

• amountAvg - average amount of payment e.g. "-50.50"

• amountAvgMonthly - average monthly payment amount e.g. "-20.00"

• total - amount of total payments identified for source in the affordability snapshot e.g. "-146.50"

changeHistory

Each transaction (repeated for each source ordered by most recent):

• amount - amount of payment

• date - date e.g. "2019-03-15"

• source - full transaction description

links

A links object containing the following members:

• self - link to the affordability resource

• income - income

• expenses - expenses

• accounts - an array of accounts
  links