---
title: "Get an existing affordability income calculation for a user"
method: GET
path: "/affordability/income/{reportId}"
tags: ["affordability"]
---

# Get an existing affordability income calculation for a user

`GET /affordability/income/{reportId}`

## Request

- Base URL: `https://api.moneyhub.co.uk/v2.0`
- URL: `https://api.moneyhub.co.uk/v2.0/affordability/income/{reportId}`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/moneyhub/apis/moneyhub-data-api/docs/affordability/income/:reportId/get.ts> (a function with typed inputs; its response is checked against the schema)

Requires **affordability_income:read** scope.

## Path parameters

- `reportId` string, uuid, required

## Response `200`

Successful Affordability Income Response

- object
  - `data` AffordabilityIncome
    - `createdAt` string, required: The timestamp at which the report was generated
    - `id` string, required: The report id
    - `income` object
      - `amountConsistency` number, required: Consistency of monthly income, as a number between 0 and 1
      - `longevity` object, required
        - `consecutiveIncomeMonths` number: Longevity of income detected in number of months
        - `incomePeriodLengthMonths` number: The number of months of transaction history available for the income detection process
      - `predicted` object, required: The predicted monthly income amount
        - `value` integer, required: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
        - `majorUnits` integer: The positive major units of the value, based on the values currency, eg. pounds for GBP.
        - `minorUnits` integer: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
        - `currency` string, required: The currency of the amount
      - `regularIncomeDetected` boolean, required: Whether or not regular income was detected
    - `overview` object
      - `income` object, required: The median monthly income
        - `value` integer, required: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
        - `majorUnits` integer: The positive major units of the value, based on the values currency, eg. pounds for GBP.
        - `minorUnits` integer: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
        - `currency` string, required: The currency of the amount
      - `incomeIncludingTransfers` object: The median monthly income including incoming transfers when incoming transfers exceed outgoing transfers
        - `value` integer, required: The amount in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
        - `majorUnits` integer: The positive major units of the value, based on the values currency, eg. pounds for GBP.
        - `minorUnits` integer: The positive minor units of the value, based on the values currency, eg. pennies for GBP.
        - `currency` string, required: The currency of the amount
    - `primaryIncomeAccountId` string: The account id of the detected primary income account
  - `links` Links
    - `next` string, uri: The url to retrieve the next page of results from
    - `prev` string, uri: The url to retrieve the previous page of results from
    - `self` string, uri, required: The url of the current resource(s)
  - `meta` object

## Other responses

- `401`: Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token
- `403`: Unsuccessful Response - Forbidden - Invalid scopes
- `404`: Unsuccessful Response - Resource Not found

---

[API](https://skmtc.dev/moneyhub/apis/moneyhub-data-api.md) - [All operations](https://skmtc.dev/moneyhub/apis/moneyhub-data-api/llms.txt) - [OpenAPI document](https://skmtc.dev/moneyhub/apis/moneyhub-data-api/revisions/f2eb965eb9af?raw)