v1
latestOpenAPI 3.0.02026-07-2482421001.1 KBIncome
Income summary
Retrieve a summarized view of income data for a specific <glossary:Book> in Ocrolus.
get/v2/book/{book_uuid}/income/summary
Path parameters
book_uuidstring uuid required
The unique identifier of the <glossary:Book> from which the income summary is retrieved.
Query parameters
guideline'FANNIE_MAE' | 'FREDDIE_MAC' | 'FHA' | 'VA' | 'USDA'
Example:FANNIE_MAE
The guideline to be used for retrieving the income summary. Supported values include FANNIE_MAE, FREDDIE_MAC, FHA, VA, and USDA.
Response
Success
Example response
{
"response": {
"book_uuid": "13e6d579-4699-43e2-a419-8a29bcb5f922",
"income_summary_data": [
{
"borrower_uuid": "8e52e9b6-6254-45a7-b008-1cebb825cfed",
"borrower_name": "JILL SMITH",
"wage_earner_income": {
"is_income_calculated": true,
"is_empty": true,
"alerts": [
{
"message": "Choose the default income type on wage earner tab to see the correct total income for JOHN SAMPLE.",
"severity": "HIGH."
}
]
},
"self_employed_income": {
"is_income_calculated": true,
"total_income": 9374.429166666667,
"alerts": []
},
"rental_income": {
"is_income_calculated": true,
"total_income": 359.9583333333333,
"alerts": []
},
"other_income": {
"is_income_calculated": true,
"total_income": 2078.2166666666667,
"alerts": []
},
"total_income": 11812.604166666668
}
],
"status": "success",
"message": "Success",
"total": 18398.12416666667
}
}