Blueprint

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 Borrower Base Commission Bonus Tips Overtime Other
YTD 0 0 0 0 0 0
One Year Average 1 1 1 1 1 1
Two Year Average 2 2 2 2 2 2
User Selected 4 4 4 4 4 4
Calculated 5 na na na na na
Annualize  na 6 6 6 6 6
Not Used 9 9 9 9 9 9
Enum variable baseEnum CommissionEnum BonusEnum voeTipsEnum OvertimeEnum OherEnum

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

Maping of API calculation value names to calculation type

Employed Borrower Base Commission Bonus Tips Overtime Other
YTD rbBaseYTD rbCommissionYTD rbBonus voeTipsYTD rbOvertimeYTD voeOtherYTD
One Year Average rbBasePrev rbCommissionYTD1 rbBonusYTD1 voeTipsYTD1 rbOvertimeYTD1 voeOtherYTD1
Two Year Average rbBasePrevPrev rbCommissionYTD2 rbBonusYTD2 voeTipsYTD2 rbOvertimeYTD2 voeOtherYTD3
User Selected BaseUser CommissionUser BonusUser voeTipsUser rbOvertimeUser voeOtherUser
Calculated calcCalculated na na na na na
Annualize  na rbCommAnnu rbBonusAnnu rbTipsAnnu rbOvertimeAnnu  
             
Enum variable baseEnum CommissionEnum BonusEnum voeTipsEnum OvertimeEnum OherEnum

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

Employed Borrower Enum Comment
Calculated (Base only) 1  
Calculated 2  
YTD All n/a  
One Year Average n/a  
Two Year Average n/a  
User Selected 6  
     
Enum variable w2FlavorEnum  

Self Employed Borrower

1065 / 1120 / 1120S

Self-Employed Borrower Enum Comment
One Year Average 1  
Two Year Average 2  
Profit and Loss 0  
User Selected 4  
Income Not Used 9  
     
Enum Variable finalIncomeEnum  

SchC / SchC-EZ / SchF

Self-Employed Borrower Enum Comment
One Year Average 1  
Two Year Average 2  
User Selected 4  
Profit and Loss 0  
Income Not Used 9  
     
Enum Variable finalIncomeEnum  

Misc Income

Investment / Social Security / Child Support / Royalty

Self-Employed Borrower Enum Comment
One Year Average 1  
Two Year Average 2  
User Selected 4  
Income Not Used 9  
     
Enum Variable invEnum finalIncomeEnum    

Unemployment Income

  Enum Comment
YTD 0  
One Year Average 1  
Two Year Average 2  
User Selected 4  
Income Not Used 9  
     
Enum Variable rbEnum  
Was this article helpful?

Related Articles