---
title: "Income summary"
method: GET
path: "/v2/book/{book_uuid}/income/summary"
tags: ["Income"]
---

# Income summary

`GET /v2/book/{book_uuid}/income/summary`

Retrieve a summarized view of income data for a specific <<glossary:Book>> in Ocrolus.

## Path parameters

- `book_uuid` string, uuid, required

## Query parameters

- `guideline` 'FANNIE_MAE' | 'FREDDIE_MAC' | 'FHA' | 'VA' | 'USDA'

## Response `200`

Success

- object
  - `response` object
    - `book_uuid` string, uuid — Unique identification code of a <<glossary:Book>>.
    - `income_summary_data` object[]
      - `borrower_uuid` string, uuid — Unique identification code of the borrower.
      - `borrower_name` string — Name of the borrower.
      - `wage_earner_income` object
        - `is_income_calculated` boolean — Indicates if the wage earner income is calculated.
        - `is_empty` boolean — Indicates if the wage earner income is empty.
        - `total_income` number, float — Total wage earner income.
        - `alerts` object[] — List of alerts related to wage earner income.
          - `message` string — Alert message.
          - `severity` string — Severity of the alert.
      - `self_employed_income` object
        - `is_income_calculated` boolean — Indicates if the self-employed income is calculated.
        - `is_empty` boolean — Indicates if the self-employed income is empty.
        - `total_income` number, float — Total self-employed income.
        - `alerts` object[] — List of alerts related to self-employed income.
          - `message` string — Alert message.
          - `severity` string — Severity of the alert.
      - `rental_income` object
        - `is_income_calculated` boolean — Indicates if the rental income is calculated.
        - `is_empty` boolean — Indicates if the rental income is empty.
        - `total_income` number, float — Total rental income.
        - `alerts` object[] — List of alerts related to rental income.
          - `message` string — Alert message.
          - `severity` string — Severity of the alert.
      - `other_income` object
        - `is_income_calculated` boolean — Indicates if the other income is calculated.
        - `is_empty` boolean — Indicates if the other income is empty.
        - `total_income` number, float — Total other income.
        - `alerts` object[] — List of alerts related to other income.
          - `message` string — Alert message.
          - `severity` string — Severity of the alert.
      - `total_income` number, float — Total income of the borrower.
    - `status` string — Status of the response.
    - `message` string — A textual description that indicates details about this response's status.
    - `total` number, float — Total income across all borrowers.

## Other responses

- `400` — Client Errors
- `404` — Client Errors

---

[API](https://skmtc.net/ocrolus/apis/user-management.md) · [All operations](https://skmtc.net/ocrolus/apis/user-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ocrolus/user-management/revisions/3571ef602d13/schema)