Blueprint

  1. Home
  2. Knowledge Base
  3. IncomeXpert
  4. API Calculation Type Selection

API Calculation Type Selection

In the API you can select from a number of different calculation types.  The following list outlines the enumeration values versus the calculation type.

For the website users, these enum values map back to the radio buttons in the Income Analysis section of the INCOME page.

Example Income Analysis table for Employed borrower with VOE.  Other income types have different Income Analysis tables and will differ.

Employed Borrower

Hourly / Salary / Commission / Bonus / Tips / Overtime with VOE

Employed BorrowerBaseCommissionBonusTipsOvertimeOther
YTD000000
One Year Average111111
Two Year Average222222
User Selected444444
Calculated5nanananana
Annualize na66666
Not Used999999
Enum variablebaseEnumCommissionEnumBonusEnumvoeTipsEnumOvertimeEnumOherEnum

Hourly / Salary / Commission / Bonus / Tips / Overtime with VOE

Maping of API calculation value names to calculation type

Employed BorrowerBaseCommissionBonusTipsOvertimeOther
YTDrbBaseYTDrbCommissionYTDrbBonusvoeTipsYTDrbOvertimeYTDvoeOtherYTD
One Year AveragerbBasePrevrbCommissionYTD1rbBonusYTD1voeTipsYTD1rbOvertimeYTD1voeOtherYTD1
Two Year AveragerbBasePrevPrevrbCommissionYTD2rbBonusYTD2voeTipsYTD2rbOvertimeYTD2voeOtherYTD3
User SelectedBaseUserCommissionUserBonusUservoeTipsUserrbOvertimeUservoeOtherUser
CalculatedcalcCalculatednanananana
Annualize narbCommAnnurbBonusAnnurbTipsAnnurbOvertimeAnnu 
       
Enum variablebaseEnumCommissionEnumBonusEnumvoeTipsEnumOvertimeEnumOherEnum

Hourly / Salary / Commission / Bonus / Tips / Overtime with paystub

Employed BorrowerEnumComment
Calculated (Base only)1 
Calculated2 
YTD Alln/a 
One Year Averagen/a 
Two Year Averagen/a 
User Selected6 
   
Enum variablew2FlavorEnum 

Self Employed Borrower

1065 / 1120 / 1120S

Self-Employed BorrowerEnumComment
One Year Average1 
Two Year Average2 
Profit and Loss0 
User Selected4 
Income Not Used9 
   
Enum VariablefinalIncomeEnum 

SchC / SchC-EZ / SchF

Self-Employed BorrowerEnumComment
One Year Average1 
Two Year Average2 
User Selected4 
Profit and Loss0 
Income Not Used9 
   
Enum VariablefinalIncomeEnum 

Misc Income

Investment / Social Security / Child Support / Royalty

Self-Employed BorrowerEnumComment
One Year Average1 
Two Year Average2 
User Selected4 
Income Not Used9 
   
Enum VariableinvEnum finalIncomeEnum   

Unemployment Income

 EnumComment
YTD0 
One Year Average1 
Two Year Average2 
User Selected4 
Income Not Used9 
   
Enum VariablerbEnum 
Was this article helpful?

Related Articles

Popular Articles

Need Support?

Can’t find what you need?”