---
title: "Get and Generate Income Report"
method: GET
path: "/rest/income-report"
tags: ["Income Report"]
---

# Get and Generate Income Report

`GET /rest/income-report`

Get Income Report for an account or an access creating the report on the fly

## Parameters

- `#/paths/~1catalog/get/parameters/0` — unresolved $ref
- `#/paths/~1rest~1timeline/get/parameters/5` — unresolved $ref
- `#/paths/~1rest~1timeline/get/parameters/4` — unresolved $ref
- `#/paths/~1rest~1timeline/get/parameters/0` — unresolved $ref
- `#/paths/~1rest~1timeline/get/parameters/1` — unresolved $ref

## Response `200`

The income report generated as per request parameters

- object — The user's income report
  - `id` string, uuid, required — ID of the report
  - `period` integer, required — The period in months for which the income report was requested
  - `regular_expenses` object[], required — Regular expenses, such as rent payments, monthly phone payments, quarterly radio tax payments
    - `summary` Summary, required — unresolved $ref
  - `variable_expenses` Items[], required — Variable expenses - all expenses that are not regular, such as grocery shopping, buying clothes — unresolved $ref
  - `disposable_income` object, required — The amount left after deducting regular expenses from the total income. The formula for calculating this would be total_income - regular_expenses
    - `total` number, float, required — Total amount of transactions
    - `low` number, float, required — Highest expense / Lowest deposit
    - `high` number, float, required — Lowest expense / Highest deposit
    - `average` number, float, required — The arithmetic average of the amounts
    - `ratio` number, float, required — The ratio of the disposable/discretionary income to the total income amount. Example: a total income amount of 1000 with a leftover of 500 yields a ratio of 0.5
  - `discretionary_income` DisposableIncome, required — unresolved $ref
  - `created_at` string, date-time, required — The time at which the report was generated.

## Other responses

- `401` — unresolved $ref

---

[API](https://skmtc.net/qwist/apis/finx-api.md) · [All operations](https://skmtc.net/qwist/apis/finx-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/qwist/finx-api/revisions/b75f5c1aa39e/schema)