v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB

Income

Income calculations

This API provides income values based on the specified guidelines for a <glossary:Book> type. The supported income types include wage-earner, self-employed, rental, and other income. A detailed description of income-related fields found in the calculated_fields objects within the totals array can be found in the income calculation definition. These fields include attributes like field name, default value, and title/header to identify and interpret each data point.

👍 Tips To retrieve Fannie Mae income calculation data, first call the Fannie Mae self-employed income calculation API, and then call the this income calculation API.

get/v2/book/{book_uuid}/income-calculations

Path parameters

book_uuidstring uuid required

The unique identifier of the <glossary:Book> from which the income calculations are retrieved.

Query parameters

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

Example:FANNIE_MAE

The guideline to be used for retrieving the income calculations. Supported values include FANNIE_MAE, FREDDIE_MAC, FHA, VA, and USDA.

Response

Success

Example response

{
  "response": {
    "book_uuid": "13e6d579-4699-43e2-a419-8a29bcb5f922",
    "incomes": [
      {
        "borrower_uuid": "8e52e9b6-6254-45a7-b008-1cebb825cfed",
        "business_uuid": "9857f0f3-991c-433c-ad77-f780b75a98fd",
        "income_type": "SELF_EMPLOYED",
        "year": "2022",
        "forms": [
          {
            "form_type": "A_1065_2022",
            "form_uuid": "b0d17733-42d9-448c-b7ce-f28c6f555c27",
            "mixed_uploaded_doc_pk": "14825462",
            "uploaded_doc_pk": "78169748",
            "page_doc_pks": [
              "548665097"
            ]
          }
        ],
        "fields": [
          {
            "name": "depletion",
            "value": "0",
            "title": "d. Depletion (Line 17)",
            "page_doc_pk": "548665097"
          }
        ],
        "calculated_fields": [
          {
            "name": "subtotal",
            "value": "2000",
            "title": "Subtotal"
          }
        ],
        "currency": "USD",
        "income_by_tax_returns": "IRS Form 1065 - Partnership Income",
        "xid": "XID-1",
        "pay_type": "Misc Income",
        "other_income_collection": "Tip income",
        "hourly_rate": "23.0",
        "hours_worked_per_week": "16.0",
        "monthly_income": "0",
        "period_earnings": "0",
        "is_active": true,
        "is_selected": true
      }
    ],
    "borrowers": [
      {
        "uuid": "f27c4a63-9b1e-427e-8df6-6cc3fac16e58",
        "name": "JACK SMITH"
      }
    ],
    "employers": [
      {
        "uuid": "e578b4b1-514e-4570-90fb-38951b6f7bd0",
        "name": "FINANCE AND INSURANCE COMPANY"
      }
    ],
    "properties": [
      {
        "uuid": "9b64690d-7448-41a2-b1a6-f2e9e01ed647",
        "address": "123 MAIN STREET OCROLUS NY 54321",
        "address_line1": "4257 W 158TH ST",
        "city": "CLEVELAND",
        "state": "OH",
        "postal_code": "44135"
      }
    ],
    "alerts": [
      {
        "message": "Non-recurring income or losses detected on (Lines 5, 6 & 7) in 1065.",
        "severity": "MEDIUM",
        "income_type": "SELF_EMPLOYED"
      }
    ],
    "totals": [
      {
        "borrower_uuid": "a1d4c349-f630-4239-b268-ee22c7c23654",
        "income_type": "WAGE_EARNER",
        "business_uuid": "9ebe8d61-c2e2-4b04-8421-c24b5e841aca",
        "calculated_fields": [
          {
            "name": "monthly_bonus",
            "value": "14.58",
            "title": "Bonus Income"
          }
        ]
      }
    ]
  }
}