Guides
Start free trialRaise a request

Wage earner income

Suggest Edits

The wage-earner income is an earning derived from a borrower’s employment, typically through regular salary or hourly wages, as documented by pay stubs, WVOEs (Verification of Employment), and W2s. The supported pay types for the wage earner income are Bonus Income, Commission Income, Hourly Income, Military Income, Misc Income, Overtime Income, Salary Income, and Shift Differential Income.

To learn more about the income calculations, see income calculations API reference page.

Bonus income

Any compensation earned beyond the standard income expectation, and not received on a predictable schedule, is typically categorized as bonus income.

Captured fields

Field nameTitleData typeDescription
ytd_earningsEarningsstringTotal year-to-date earnings reported.
months_elapsed# MonthsstringNumber of months elapsed in the current year.
monthly_incomeMonthly IncomestringAverage monthly income based on earnings and months elapsed.
"fields": 
[
  {
    "name": "ytd_earnings",
    "value": "100.0",
    "title": "Earnings",
    "page_doc_pk": "14959404"
  },
  {
    "name": "months_elapsed",
    "value": "5.33",
    "title": "# Months",
    "page_doc_pk": "14959404"
  },
  {
    "name": "monthly_income",
    "value": "18.76",
    "title": "Monthly Income",
    "page_doc_pk": "14959404"
  }
]

Calculated fields

Field nameTitleData typeDescription
ytd_avgYTD AvgstringYear-to-date average income.
key_usedKey UsedstringThe key used to derive the final income calculation.
is_editedIs EditedbooleanA boolean indicating whether the calculated income value was manually adjusted.
default_keyDefault KeystringThe default calculation key is used if no user override is provided.
ytd_one_year_avgYTD + 1 yr AvgstringCombined average of YTD and the previous year's income.
ytd_two_year_avgYTD + 2 yr AvgstringCombined average of YTD and the last two years' income.
past_year_avgPast yr AvgstringAverage income based solely on the previous year.
past_year_and_additional_year_avgPast + 1 yr avgstringAverage income using the past year and one additional year.
recommended_incomeRecommended IncomestringFinal recommended monthly income value from Ocrolus.
"calculated_fields": [
        {
          "name": "ytd_avg",
          "value": "25.0",
          "title": "YTD Avg"
        },
        {
          "name": "key_used",
          "value": "past_year_and_additional_year_avg",
          "title": "Key Used"
        },
        {
          "name": "is_edited",
          "value": "False",
          "title": "is_edited"
        },
        {
          "name": "default_key",
          "value": "past_year_and_additional_year_avg",
          "title": "Default Key"
        },
        {
          "name": "recommended_income",
          "value": "14.58",
          "title": "Recommended Income"
        },
        {
          "name": "past_year_avg",
          "value": "16.67",
          "title": "Past yr Avg"
        },
        {
          "name": "ytd_one_year_avg",
          "value": "20.83",
          "title": "YTD + 1 yr Avg"
        },
        {
          "name": "ytd_two_year_avg",
          "value": "18.06",
          "title": "YTD + 2 yr Avg"
        },
        {
          "name": "past_year_and_additional_year_avg",
          "value": "14.58",
          "title": "Past + 1 yr avg"
        }
      ]

Commission income

Captured fields

Field nameTitleData typeDescription
ytd_earningsEarningsstringTotal year-to-date commission earnings reported.
months_elapsed# MonthsstringNumber of months elapsed in the current year.
monthly_incomeMonthly IncomestringCalculated average monthly commission income.
"fields": [
        {
          "name": "ytd_earnings",
          "value": "120.0",
          "title": "Earnings",
          "page_doc_pk": "14959404"
        },
        {
          "name": "months_elapsed",
          "value": "5.33",
          "title": "# Months",
          "page_doc_pk": "14959404"
        },
        {
          "name": "monthly_income",
          "value": "22.51",
          "title": "Monthly Income",
          "page_doc_pk": "14959404"
        }
      ]

Calculated fields

Field nameTitleData typeDescription
ytd_avgYTD AvgstringYear-to-date average income.
key_usedKey UsedstringThe key used to derive the final income calculation.
is_editedIs EditedbooleanA boolean indicating whether the calculated income value was manually adjusted.
default_keyDefault KeystringThe default key used if no specific override is provided.
ytd_one_year_avgYTD + 1 yr AvgstringAverage of current year-to-date and previous year income.
ytd_two_year_avgYTD + 2 yr AvgstringAverage of current YTD and the last two years' income.
past_year_avgPast yr AvgstringThe income average based solely on the past year.
past_year_and_additional_year_avgPast + 1 yr avgstringAverage income using the past year and one additional year.
recommended_incomeRecommended IncomestringFinal recommended monthly income value from Ocrolus.
"calculated_fields": [
        {
          "name": "ytd_avg",
          "value": "22.51",
          "title": "YTD Avg"
        },
        {
          "name": "key_used",
          "title": "Key Used"
        },
        {
          "name": "is_edited",
          "value": "False",
          "title": "is_edited"
        },
        {
          "name": "default_key",
          "title": "Default Key"
        },
        {
          "name": "recommended_income",
          "value": "0",
          "title": "Recommended Income"
        },
        {
          "name": "past_year_avg",
          "value": "0",
          "title": "Past yr Avg"
        },
        {
          "name": "ytd_one_year_avg",
          "value": "0",
          "title": "YTD + 1 yr Avg"
        },
        {
          "name": "ytd_two_year_avg",
          "value": "0",
          "title": "YTD + 2 yr Avg"
        },
        {
          "name": "past_year_and_additional_year_avg",
          "value": "0",
          "title": "Past + 1 yr avg"
        }
      ]

Hourly income

Hourly income refers to compensation based on a defined hourly rate and recorded hours worked, typically categorized under types like hourly, PTO, or vacation.

Captured fields

Field nameTitleData typeDescription
ytd_earningsEarningsstringTotal year-to-date earnings reported.
months_elapsed# MonthsstringNumber of months elapsed in the current year.
monthly_incomeMonthly IncomestringAverage monthly income based on earnings and months elapsed.
"fields": [
  {
    "name": "ytd_earnings",
    "value": "8000.0",
    "title": "Earnings",
    "page_doc_pk": "14959404"
  },
  {
    "name": "months_elapsed",
    "value": "5.33",
    "title": "# Months",
    "page_doc_pk": "14959404"
  },
  {
    "name": "monthly_income",
    "value": "1500.94",
    "title": "Monthly Income",
    "page_doc_pk": "14959404"
  }
]

Calculated fields

Field nameTitleData typeDescription
ytd_avgYTD AvgstringYear-to-date average income.
key_usedKey UsedstringThe key used to derive the final income calculation.
is_editedIs EditedbooleanA boolean indicating whether the calculated income value was manually adjusted.
default_keyDefault KeystringThe default calculation key is used if no user override is provided.
ytd_one_year_avgYTD + 1 yr AvgstringCombined average of YTD and the previous year's income.
ytd_two_year_avgYTD + 2 yr AvgstringCombined average of YTD and the last two years' income.
past_year_avgPast yr AvgstringAverage income based solely on the previous year.
monthly_incomeMonthly IncomestringHourly income in a month.
past_year_and_additional_year_avgPast + 1 yr avgstringAverage income using the past year and one additional year.
recommended_incomeRecommended IncomestringFinal recommended monthly income value from Ocrolus.
"calculated_fields": [
  {
    "name": "ytd_avg",
    "value": "1500.94",
    "title": "YTD Avg"
  },
  {
    "name": "key_used",
    "value": "ytd_avg",
    "title": "Key Used"
  },
  {
    "name": "is_edited",
    "value": "False",
    "title": "is_edited"
  },
  {
    "name": "default_key",
    "value": "ytd_avg",
    "title": "Default Key"
  },
  {
    "name": "recommended_income",
    "value": "1500.94",
    "title": "Recommended Income"
  },
  {
    "name": "past_year_avg",
    "value": "0",
    "title": "Past yr Avg"
  },
  {
    "name": "monthly_income",
    "value": "0",
    "title": "Monthly Income"
  },
  {
    "name": "ytd_one_year_avg",
    "value": "0",
    "title": "YTD + 1 yr Avg"
  },
  {
    "name": "ytd_two_year_avg",
    "value": "0",
    "title": "YTD + 2 yr Avg"
  },
  {
    "name": "past_year_and_additional_year_avg",
    "value": "0",
    "title": "Past + 1 yr avg"
  }
]

Military income

It is the compensation from enlistment in the United States military.

Captured fields

Field nameTitleData typeDescription
bas_and_bahbas_and_bahstringBasic Allowance for Subsistence and Housing combined.
other_allowanceOther AllowancestringAdditional allowances not categorized under specific military pay types.
military_base_payBase PaystringRegular base salary received by military personnel.
military_prop_payProp PaystringProportional pay granted under special military provisions.
rations_allowanceRations AllowancestringMonetary allowance for food provided to military personnel.
clothing_allowanceclothing_allowancestringFunds provided for uniforms and clothing expenses.
quarters_allowanceQuarters AllowancestringAllowance to cover housing expenses.
military_combat_payCombat PaystringExtra compensation for service in designated combat zones.
military_flight_payFlight PaystringAdditional pay for military personnel involved in flight duties.
military_hazard_payHazard PaystringCompensation for duty in potentially hazardous environments.
military_overseas_payOverseas PaystringAdditional compensation for service performed overseas.
variable_housing_allowanceVariable Housing AllowancestringFlexible housing subsidy depending on the duty station location.
"fields": [
  {
    "name": "bas_and_bah",
    "value": "0",
    "title": "bas_and_bah"
  },
  {
    "name": "other_allowance",
    "value": "0",
    "title": "Other Allowance"
  },
  {
    "name": "military_base_pay",
    "value": "0",
    "title": "Base Pay"
  },
  {
    "name": "military_prop_pay",
    "value": "0",
    "title": "Prop Pay"
  },
  {
    "name": "rations_allowance",
    "value": "0",
    "title": "Rations Allowance"
  },
  {
    "name": "clothing_allowance",
    "value": "0",
    "title": "clothing_allowance"
  },
  {
    "name": "quarters_allowance",
    "value": "0",
    "title": "Quarters Allowance"
  },
  {
    "name": "military_combat_pay",
    "value": "0",
    "title": "Combat Pay"
  },
  {
    "name": "military_flight_pay",
    "value": "0",
    "title": "Flight Pay"
  },
  {
    "name": "military_hazard_pay",
    "value": "0",
    "title": "Hazard Pay"
  },
  {
    "name": "military_overseas_pay",
    "value": "0",
    "title": "Overseas Pay"
  },
  {
    "name": "variable_housing_allowance",
    "value": "0",
    "title": "Variable Housing Allowance"
  }
]

Calculated fields

Field nameTitleData typeDescription
base_payBase PaystringThe base income derived from military pay without allowances or additional benefits.
key_usedKey UsedstringIndicates the calculation key selected for determining income (e.g., YTD average, prior year average).
is_editedis_editedbooleanA boolean indicating whether the calculated income value was manually adjusted.
default_keyDefault KeystringA key to be used if no primary key is selected or applicable for income calculation.
entitlementsEntitlementsstringThe total of all non-base pay military benefits, such as allowances.
recommended_incomeRecommended IncomestringFinal recommended monthly income value from Ocrolus.
entitlements_and_base_payEntitlements + Base PaystringCombined total of base military pay and all entitlements.
entitlements_grossed_up_fifteen_percent_and_base_payGrossed up 15% + base paystringTotal income with a 15% gross-up applied to entitlements, added to base pay.
entitlements_grossed_up_twenty_five_percent_and_base_payGrossed up 25% + base paystringTotal income with a 25% gross-up applied to entitlements, added to base pay.
"calculated_fields": [
  {
    "name": "base_pay",
    "value": "0",
    "title": "Base Pay"
  },
  {
    "name": "key_used",
    "title": "Key Used"
  },
  {
    "name": "is_edited",
    "value": "False",
    "title": "is_edited"
  },
  {
    "name": "default_key",
    "title": "Default Key"
  },
  {
    "name": "entitlements",
    "value": "0",
    "title": "Entitlements"
  },
  {
    "name": "recommended_income",
    "value": "0",
    "title": "Recommended Income"
  },
  {
    "name": "entitlements_and_base_pay",
    "value": "0",
    "title": "Entitlements + Base Pay"
  },
  {
    "name": "entitlements_grossed_up_fifteen_percent_and_base_pay",
    "value": "0",
    "title": "Grossed up 15% + base pay"
  },
  {
    "name": "entitlements_grossed_up_twenty_five_percent_and_base_pay",
    "value": "0",
    "title": "Grossed up 25% + base pay"
  }
]

Miscellaneous income

Any recurring employment income that couldn't be categorized can be termed as miscellaneous income.

Captured fields

Field nameTitleData typeDescription
ytd_earningsEarningsstringTotal year-to-date earnings reported.
months_elapsed# MonthsstringNumber of months elapsed in the current year.
monthly_incomeMonthly IncomestringAverage monthly income based on earnings and months elapsed.
"fields": [
  {
    "name": "ytd_earnings",
    "value": "100.0",
    "title": "Earnings",
    "page_doc_pk": "14959404"
  },
  {
    "name": "months_elapsed",
    "value": "5.33",
    "title": "# Months",
    "page_doc_pk": "14959404"
  },
  {
    "name": "monthly_income",
    "value": "18.76",
    "title": "Monthly Income",
    "page_doc_pk": "14959404"
  }
]

Calculated fields

Field nameTitleData typeDescription
ytd_avgYTD AvgstringYear-to-date average income.
key_usedKey UsedstringThe key used to derive the final income calculation.
is_editedIs EditedbooleanA boolean indicating whether the calculated income value was manually adjusted.
default_keyDefault KeystringThe default calculation key is used if no user override is provided.
recommended_incomeRecommended IncomestringFinal recommended monthly income value from Ocrolus.
past_year_avgPast yr AvgstringAverage income based solely on the previous year.
ytd_one_year_avgYTD + 1 yr AvgstringCombined average of YTD and the previous year's income.
ytd_two_year_avgYTD + 2 yr AvgstringCombined average of YTD and the last two years' income.
past_year_and_additional_year_avgPast + 1 yr avgstringAverage income using the past year and one additional year.
"calculated_fields": [
  {
    "name": "ytd_avg",
    "value": "18.76",
    "title": "YTD Avg"
  },
  {
    "name": "key_used",
    "title": "Key Used"
  },
  {
    "name": "is_edited",
    "value": "False",
    "title": "is_edited"
  },
  {
    "name": "default_key",
    "title": "Default Key"
  },
  {
    "name": "recommended_income",
    "value": "0",
    "title": "Recommended Income"
  },
  {
    "name": "past_year_avg",
    "value": "0",
    "title": "Past yr Avg"
  },
  {
    "name": "ytd_one_year_avg",
    "value": "11.54",
    "title": "YTD + 1 yr Avg"
  },
  {
    "name": "ytd_two_year_avg",
    "value": "0",
    "title": "YTD + 2 yr Avg"
  },
  {
    "name": "past_year_and_additional_year_avg",
    "value": "0",
    "title": "Past + 1 yr avg"
  }
]

Overtime income

Income earned for hours worked above the standard or expected weekly hours.

Captured fields

Field nameTitleData typeDescription
ytd_earningsEarningsstringTotal year-to-date earnings reported.
months_elapsed# MonthsstringNumber of months elapsed in the current year.
monthly_incomeMonthly IncomestringAverage monthly income based on earnings and months elapsed.
"fields": [
  {
    "name": "ytd_earnings",
    "value": "200.0",
    "title": "Earnings",
    "page_doc_pk": "14959404"
  },
  {
    "name": "months_elapsed",
    "value": "5.33",
    "title": "# Months",
    "page_doc_pk": "14959404"
  },
  {
    "name": "monthly_income",
    "value": "37.52",
    "title": "Monthly Income",
    "page_doc_pk": "14959404"
  }
]

Calculated fields

Field nameTitleData typeDescription
ytd_avgYTD AvgstringYear-to-date average income.
key_usedKey UsedstringThe key used to derive the final income calculation.
is_editedIs EditedbooleanA boolean indicating whether the calculated income value was manually adjusted.
default_keyDefault KeystringThe default calculation key is used if no user override is provided.
recommended_incomeRecommended IncomestringFinal recommended monthly income value from Ocrolus.
past_year_avgPast yr AvgstringAverage income based solely on the previous year.
ytd_one_year_avgYTD + 1 yr AvgstringCombined average of YTD and the previous year's income.
ytd_two_year_avgYTD + 2 yr AvgstringCombined average of YTD and the last two years' income.
past_year_and_additional_year_avgPast + 1 yr avgstringAverage income using the past year and one additional year.
"calculated_fields": [
  {
    "name": "ytd_avg",
    "value": "37.52",
    "title": "YTD Avg"
  },
  {
    "name": "key_used",
    "value": "ytd_two_year_avg",
    "title": "Key Used"
  },
  {
    "name": "is_edited",
    "value": "False",
    "title": "is_edited"
  },
  {
    "name": "default_key",
    "value": "ytd_2_year_avg",
    "title": "Default Key"
  },
  {
    "name": "recommended_income",
    "value": "18.07",
    "title": "Recommended Income"
  },
  {
    "name": "past_year_avg",
    "value": "15.0",
    "title": "Past yr Avg"
  },
  {
    "name": "ytd_one_year_avg",
    "value": "21.93",
    "title": "YTD + 1 yr Avg"
  },
  {
    "name": "ytd_two_year_avg",
    "value": "18.07",
    "title": "YTD + 2 yr Avg"
  },
  {
    "name": "past_year_and_additional_year_avg",
    "value": "13.75",
    "title": "Past + 1 yr avg"
  }
]

Salary income

Any non-hourly earnings that are classified as regular, PTO, or vacation pay are counted as salaried income.

Captured fields

Field nameTitleData typeDescription
ytd_earningsEarningsstringTotal year-to-date earnings reported.
months_elapsed# MonthsstringNumber of months elapsed in the current year.
monthly_incomeMonthly IncomestringAverage monthly income based on earnings and months elapsed.
"fields": [
  {
    "name": "ytd_earnings",
    "value": "6500.0",
    "title": "Earnings",
    "page_doc_pk": "14959404"
  },
  {
    "name": "months_elapsed",
    "value": "12.0",
    "title": "# Months",
    "page_doc_pk": "14959404"
  },
  {
    "name": "monthly_income",
    "value": "541.67",
    "title": "Monthly Income",
    "page_doc_pk": "14959404"
  }
]

Calculated fields

Field nameTitleData typeDescription
ytd_avgYTD AvgstringYear-to-date average income.
key_usedKey UsedstringThe key used to derive the final income calculation.
is_editedIs EditedbooleanA boolean indicating whether the calculated income value was manually adjusted.
default_keyDefault KeystringThe default calculation key is used if no user override is provided.
recommended_incomeRecommended IncomestringFinal recommended monthly income value from Ocrolus.
past_year_avgPast yr AvgstringAverage income based solely on the previous year.
monthly_incomeMonthly IncomestringSalaried income in a month.
ytd_one_year_avgYTD + 1 yr AvgstringCombined average of YTD and the previous year's income.
ytd_two_year_avgYTD + 2 yr AvgstringCombined average of YTD and the last two years' income.
past_year_and_additional_year_avgPast + 1 yr avgstringAverage income using the past year and one additional year.
"calculated_fields": [
  {
    "name": "ytd_avg",
    "value": "0",
    "title": "YTD Avg"
  },
  {
    "name": "key_used",
    "title": "Key Used"
  },
  {
    "name": "is_edited",
    "value": "0",
    "title": "is_edited"
  },
  {
    "name": "default_key",
    "title": "Default Key"
  },
  {
    "name": "recommended_income",
    "value": "0",
    "title": "Recommended Income"
  },
  {
    "name": "past_year_avg",
    "value": "0",
    "title": "Past yr Avg"
  },
  {
    "name": "monthly_income",
    "value": "0",
    "title": "Monthly Income"
  },
  {
    "name": "ytd_one_year_avg",
    "value": "0",
    "title": "YTD + 1 yr Avg"
  },
  {
    "name": "ytd_two_year_avg",
    "value": "0",
    "title": "YTD + 2 yr Avg"
  },
  {
    "name": "past_year_and_additional_year_avg",
    "value": "0",
    "title": "Past + 1 yr avg"
  }
]

Shift differential income

Compensation paid at a premium pay rate for hours worked at non-traditional times, such as nights, weekends, or holidays.

Captured fields

Field nameTitleData typeDescription
ytd_earningsEarningsstringTotal year-to-date earnings reported.
months_elapsed# MonthsstringNumber of months elapsed in the current year.
monthly_incomeMonthly IncomestringAverage monthly income based on earnings and months elapsed.
"fields": [
  {
    "name": "ytd_earnings",
    "value": "300.0",
    "title": "Earnings",
    "page_doc_pk": "14959404"
  },
  {
    "name": "months_elapsed",
    "value": "5.33",
    "title": "# Months",
    "page_doc_pk": "14959404"
  },
  {
    "name": "monthly_income",
    "value": "25.0",
    "title": "Monthly Income",
    "page_doc_pk": "14959404"
  }
]

Calculated fields

Field nameTitleData typeDescription
ytd_avgYTD AvgstringYear-to-date average income.
key_usedKey UsedstringThe key used to derive the final income calculation.
is_editedIs EditedbooleanA boolean indicating whether the calculated income value was manually adjusted.
default_keyDefault KeystringThe default calculation key is used if no user override is provided.
recommended_incomeRecommended IncomestringFinal recommended monthly income value from Ocrolus.
past_year_avgPast yr AvgstringAverage income based solely on the previous year.
ytd_one_year_avgYTD + 1 yr AvgstringCombined average of YTD and the previous year's income.
ytd_two_year_avgYTD + 2 yr AvgstringCombined average of YTD and the last two years' income.
past_year_and_additional_year_avgPast + 1 yr avgstringAverage income using the past year and one additional year.
"calculated_fields": [
  {
    "name": "ytd_avg",
    "value": "25.0",
    "title": "YTD Avg"
  },
  {
    "name": "key_used",
    "value": "past_year_and_additional_year_avg",
    "title": "Key Used"
  },
  {
    "name": "is_edited",
    "value": "False",
    "title": "is_edited"
  },
  {
    "name": "default_key",
    "value": "past_year_and_additional_year_avg",
    "title": "Default Key"
  },
  {
    "name": "recommended_income",
    "value": "14.58",
    "title": "Recommended Income"
  },
  {
    "name": "past_year_avg",
    "value": "16.67",
    "title": "Past yr Avg"
  },
  {
    "name": "ytd_one_year_avg",
    "value": "20.83",
    "title": "YTD + 1 yr Avg"
  },
  {
    "name": "ytd_two_year_avg",
    "value": "18.06",
    "title": "YTD + 2 yr Avg"
  },
  {
    "name": "past_year_and_additional_year_avg",
    "value": "14.58",
    "title": "Past + 1 yr avg"
  }
]

Totals

Field nameTitle
monthly_bonusBonus Income
monthly_commissionCommission Income
monthly_hourlyHourly Income
monthly_military_entitlementsMilitary Income
monthly_otherMisc Income
monthly_overtimeOvertime Income
monthly_salarySalary Income
monthly_shift_differentialShift Differential Income
monthly_totalRecommended Income
{
  "monthly_hourly": "Hourly Income",
  "monthly_salary": "Salary Income",
  "monthly_overtime": "Overtime Income",
  "monthly_bonus": "Bonus Income",
  "monthly_commission": "Commission Income",
  "monthly_military_entitlements": "Military Income",
  "monthly_shift_differential": "Shift Differential Income",
  "monthly_other": "Misc Income",
  "monthly_total": "Recommended Income",
}

Updated 5 months ago