---
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}`

Requires **affordability_income:read** scope.

## Path parameters

- `reportId` string, uuid, required

## Response `200`

Successful Affordability Income Response

- object
  - `data` AffordabilityIncome
    - `createdAt` string, nullable — The timestamp at which the report was generated
    - `requestedAt` string, nullable — The timestamp at which the report was requested
    - `id` string, nullable, required — The report id
    - `status` 'pending' | 'complete' | 'failed', required — Whether the report is 'complete', 'pending' or 'failed'.
    - `statusDetails` object — Additional information about the status of the report (if applicable)
      - `message` string — A message describing the status of the report, e.g. an error if the report status is 'failed'
    - `income` object, required
      - `amountConsistency` number, required — Consistency of monthly income, as a number between 0 and 1
      - `median` 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
      - `medianIncludingTransfers` object, required — 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
      - `primaryIncomeAccount` object, required
        - `uid` string — The account id of the detected primary income account
      - `longevity` object, required
        - `consecutiveIncome` object, required
          - `months` number, required — The number of consecutive months of income detected
        - `incomePeriodLength` object, required
          - `months` number, required — The number of months of transaction history available for the income detection process
      - `regularIncome` object, required
        - `isDetected` boolean, required — Whether or not regular income was detected
        - `predicted` object, required
          - `monthly` object, required
            - `amount` object, required — The predicted monthly income amount
              - …
      - `categoriesUsed` object[] — Income-based transaction categories that were used when detecting sources of income. This can be configured for a business, or if not a default list is used.
        - `uid` string, required
        - `key` string, required
  - `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.net/moneyhubenterprise/apis/moneyhub-identity-service.md) · [All operations](https://skmtc.net/moneyhubenterprise/apis/moneyhub-identity-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moneyhubenterprise/moneyhub-identity-service/revisions/8841721f7aae/schema)