1. Home
  2. Knowledge Base
  3. IncomeXpert
  4. API Mapping for Employed Income

API Mapping for Employed Income

Self-employed income has an inherent mapping built into the naming of the API signals by virtue of the tax return line numbers.  Employed borrowers (salary and hourly) require a bit more explanation to properly map the income fields in Blueprint to the API variables.

Non-VOE

The example below has three years of income shown.  The left column is the year to date (YTD), the center column is the One Year Ago, and the right column is the Two Years Ago.

{
  "borrowerID": 0,
  "employerName": "string",
  "numMonthsOnJob": 0.0,
  "lastPaycheckDate": "string",  // Item 4
  "paycheckAmount": 0.0, // Item 1
  "paycheckFrequency": 0, // Item 2
  "basePayYTD": 0.0, // Item 7
  "W2_Box5_OneYearAgo": 0.0, // Item 9
  "W2_Box5_TwoYearsAgo": 0.0, // Item 10
  "bonusYTD": 0.0, // Not used in Non-VOE
  "bonusOneYearAgo": 0.0, // Not used in Non-VOE
  "bonusTwoYearsAgo": 0.0, // Not used in Non-VOE
  "overtimeYTD": 0.0, // Not used in Non-VOE
  "overtimeOneYearAgo": 0.0, // Not used in Non-VOE
  "overtimeTwoYearsAgo": 0.0, // Not used in Non-VOE
  "commissionYTD": 0.0, // Not used in Non-VOE
  "commissionOneYearAgo": 0.0, // Not used in Non-VOE
  "commissionTwoYearsAgo": 0.0, // Not used in Non-VOE
  "finalIncome": 0.0, // Output - read only; Result of selected radio button
  "basePayPrev": 0.0, // Not used in Non-VOE
  "basePayPrevPrev": 0.0, // Not used in Non-VOE
  "baseEnum": 0, // Not used in Non-VOE
  "OvertimeEnum": 0, // Not used in Non-VOE
  "BonusEnum": 0, // Not used in Non-VOE
  "CommissionEnum": 0, // Not used in Non-VOE
  "rbBaseYTD": 0.0, // Not used in Non-VOE
  "rbBasePrev": 0.0, // Not used in Non-VOE
  "rbBasePrevPrev": 0.0, // Not used in Non-VOE
  "rbOvertimeYTD": 0.0, // Not used in Non-VOE
  "rbOvertimeYTD1": 0.0, // Not used in Non-VOE
  "rbOvertimeYTD2": 0.0, // Not used in Non-VOE
  "rbBonus": 0.0, // Not used in Non-VOE
  "rbBonusYTD1": 0.0, // Not used in Non-VOE
  "rbBonusYTD2": 0.0, // Not used in Non-VOE
  "rbCommissionYTD": 0.0, // Not used in Non-VOE
  "rbCommissionYTD1": 0.0, // Not used in Non-VOE
  "rbCommissionYTD2": 0.0, // Not used in Non-VOE
  "BaseUser": 0.0, // Not used in Non-VOE
  "OvertimeUser": 0.0, // Not used in Non-VOE
  "BonusUser": 0.0,// Not used in Non-VOE
  "CommissionUser": 0.0, // Not used in Non-VOE
  "w2FlavorEnum": 0, // Enum 1-6 selecting the radio button
  "calcBase": 0.0, // Output - radio button value w2flavorenum = 1
  "calcCalculated": 0.0, // Output - radio button value w2flavorenum = 2
  "calcYTD_All": 0.0, // Display for trending analysis 
  "calcYTD_1_YearAvg": 0.0, // Display for trending analysis 
  "calcYTD_2_YearAvg": 0.0, // Display for trending analysis 
  "calcUserEntered": 0.0, // Item 11
  "hasVOE": true,
  "YTD_All": 0.0, // Item 8
  "comment": "string",
  "cb36moEmployment": true, // Item 5
  "startDate": "string", // Item 6
  "tipsYTD": 0.0, // Not used in Non-VOE
  "tipsOneYearAgo": 0.0, // Not used in Non-VOE
  "tipsTwoYearsAgo": 0.0, // Not used in Non-VOE
  "voeTipsYTD": 0.0, // Not used in Non-VOE
  "voeTipsYTD1": 0.0, // Not used in Non-VOE
  "voeTipsYTD2": 0.0, // Not used in Non-VOE
  "voeTipsEnum": 0, // Not used in Non-VOE
  "voeTipsUser": 0.0, // Not used in Non-VOE
  "hoursPerWeek": 0.0, // Populated only if Item 2a = Hourly
  "bonusAnnualize": true, // Not used in Non-VOE
  "basePayVacYTD": 0.0, // Expansion of Item 7
  "basePayHolYTD": 0.0, // Expansion of Item 7
  "basePayDifYTD": 0.0, // Expansion of Item 7
  "basePayTotYTD": 0.0, // Expansion of Item 7
  "numPayPeriods": 0, // Not used in Non-VOE
  "basePaySickPTOYTD": 0.0, // Expansion of Item 7
  "rbOvertimeAnnu": 0.0, // Not used in Non-VOE
  "rbBonusAnnu": 0.0, // Not used in Non-VOE
  "rbCommAnnu": 0.0, // Not used in Non-VOE
  "rbTipsAnnu": 0.0 // Not used in Non-VOE"
"currentJob": true // Used in Paystub and VOE }

Paystub Income Analysis

The paystub uses the w2flavorenum to select the radio button for the average income.

1 = Calculated

2 = Base Only YTD

9 = Not Used

VOE

The example below has three years of income shown.  The left column is the year to date (YTD), the center column is the One Year Ago, and the right column is the Two Years Ago.

{
  "borrowerID": 0,
  "employerName": "string",
  "numMonthsOnJob": 0.0,
  "lastPaycheckDate": "string",  // Item 3
  "paycheckAmount": 0.0, // Item 1
  "paycheckFrequency": 0, // Frequency of Item 2
  "basePayYTD": 0.0, // Item 6
  "W2_Box5_OneYearAgo": 0.0, // Not used in VOE
  "W2_Box5_TwoYearsAgo": 0.0, // Not used in VOE
  "bonusYTD": 0.0, // Item 12
  "bonusOneYearAgo": 0.0, // Item 13
  "bonusTwoYearsAgo": 0.0, // Item 14
  "overtimeYTD": 0.0, // Item 9
  "overtimeOneYearAgo": 0.0, // Item 10
  "overtimeTwoYearsAgo": 0.0, // Item 11
  "commissionYTD": 0.0, // Item 15
  "commissionOneYearAgo": 0.0, // Item 16
  "commissionTwoYearsAgo": 0.0, // Item 17
  "finalIncome": 0.0, // Output - read only; Result of selected radio button
  "basePayPrev": 0.0, // Item 7
  "basePayPrevPrev": 0.0, // Item 8
  "baseEnum": 0, // Enum 1-9 selecting Base Income radio button
  "OvertimeEnum": 0, // Enum 1-9 selecting Overtime radio button
  "BonusEnum": 0, // Enum 1-9 selecting Overtime radio button
  "CommissionEnum": 0, // Enum 1-9 selecting Overtime radio button 
"OherEnum": 0, // Enum 1-9 selecting Other radio button "rbBaseYTD": 0.0, // Output - read only "rbBasePrev": 0.0, // Output - read only "rbBasePrevPrev": 0.0, // Output - read only "rbOvertimeYTD": 0.0, // Output - read only "rbOvertimeYTD1": 0.0, // Output - read only "rbOvertimeYTD2": 0.0, // Output - read only "rbBonus": 0.0, // Output - read only "rbBonusYTD1": 0.0, // Output - read only "rbBonusYTD2": 0.0, // Output - read only "rbCommissionYTD": 0.0, // Output - read only "rbCommissionYTD1": 0.0, // Output - read only "rbCommissionYTD2": 0.0, // Output - read only "BaseUser": 0.0, // User override for base income radio button "OvertimeUser": 0.0, // User override for overtime radio button "BonusUser": 0.0,// User override for bonus radio button "CommissionUser": 0.0, // User override for commission radio button "w2FlavorEnum": 0, // Not used in VOE "calcBase": 0.0, // Not used in VOE "calcCalculated": 0.0, // Not used in VOE "calcYTD_All": 0.0, // Not used in VOE "calcYTD_1_YearAvg": 0.0, // Not used in VOE "calcYTD_2_YearAvg": 0.0, // Not used in VOE "calcUserEntered": 0.0, // Not used in VOE "hasVOE": true, "YTD_All": 0.0, // Not used in VOE "comment": "string", "cb36moEmployment": true, // Item 4 "startDate": "string", // Item 5 "tipsYTD": 0.0, // Item 18 "tipsOneYearAgo": 0.0, // Item 19 "tipsTwoYearsAgo": 0.0, // Item 20 "voeTipsYTD": 0.0, // Output - read only "voeTipsYTD1": 0.0, // Output - read only "voeTipsYTD2": 0.0, // Output - read only "voeTipsEnum": 0, // Enum 1-9 selecting Tips radio button "voeTipsUser": 0.0, // User override of tips radio button "hoursPerWeek": 0.0, // Populated only if Item 2 = Hourly "bonusAnnualize": true, // Boolean to annualize bonus value "basePayVacYTD": 0.0, // Not used in VOE "basePayHolYTD": 0.0, // Not used in VOE "basePayDifYTD": 0.0, // Not used in VOE "basePayTotYTD": 0.0, // Not used in VOE "numPayPeriods": 0, // Item 2b "basePaySickPTOYTD": 0.0, // Not used in VOE "rbOvertimeAnnu": 0.0, // Not used in VOE "rbBonusAnnu": 0.0, // Output - read only "rbCommAnnu": 0.0, // Not used in VOE "rbTipsAnnu": 0.0 // Not used in Non-VOE
"currentJob": true // Used in VOE and Paystub }

VOE Income Analysis

The VOE uses the multiple enumerations to select the radio button for the average income.  A different enumeration is used for each income component (base, overtime, bonus, commission, tips, and other).  The enumerations follow this mapping

0 = YTD

1 = One Year Average

2 = Two Year Average

3 = FHA 24mo Average

4 = User Override

5 = Calculated (base income only)

6 = Annualized (variable income only)

9 = Not used

Was this article helpful?

Related Articles

Need Support?

Can't find the answer you're looking for?
Contact Support
Go to Top