Blueprint

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

API Mapping for REO Income

The REO (real estate owned) income type is used for rental properties, second homes, and land.  The Blueprint API can be used with two main forms, a Lease agreement or a Schedule E.  The API contains additional parameters which are not used in the Lease Agreement or SchE and are not described here.  These parameters are marked as Not Applicable and should not be used.  

Lease Agreement

{
  "REOincomeId": 0,
  "Y1TaxYear": 0.0, // Not applicable with Lease Agreement
  "Y1Gain": 0.0, // Not applicable with Lease Agreement
  "Y1Insurance": 0.0, // Not applicable with Lease Agreement
  "Y1Interest": 0.0, // Not applicable with Lease Agreement
  "Y1Taxes": 0.0, // Not applicable with Lease Agreement
  "Y1Depreciation": 0.0, // Not applicable with Lease Agreement
  "Y2Gain": 0.0, // Not applicable with Lease Agreement
  "Y2Insurance": 0.0, // Not applicable with Lease Agreement
  "Y2Interest": 0.0, // Not applicable with Lease Agreement
  "Y2Taxes": 0.0, // Not applicable with Lease Agreement
  "Y2Depreciation": 0.0, // Not applicable with Lease Agreement
  "Y3Gain": 0.0, // Not applicable with Lease Agreement
  "Y3Insurance": 0.0, // Not applicable with Lease Agreement
  "Y3Interest": 0.0, // Not applicable with Lease Agreement
  "Y3Taxes": 0.0, // Not applicable with Lease Agreement
  "Y3Depreciation": 0.0, // Not applicable with Lease Agreement
  "REOREOId": 0, // Not applicable with Lease Agreement
  "TnI_Inc": "string", // Item 7: No, Yes
  "Y1HOA": 0.0, // Not applicable with Lease Agreement
  "Y2HOA": 0.0, // Not applicable with Lease Agreement
  "Y3HOA": 0.0, // Not applicable with Lease Agreement
  "RadioEnum": 0, // Not applicable with Lease Agreement
  "finalIncome": 0.0, // Not applicable with Lease Agreement
  "CurrentTaxes": 0.0, // Item 8
  "CurrentHOI": 0.0, // Item 9
  "CurrentOther": 0.0, // Item 10
  "finalIncome_1YrAve": 0.0, // Output - Item 1
  "finalIncome_2YrAve": 0.0, // Output - Item 2
  "finalIncome_User": 0.0, // User radio button override - Item 3
  "StreetAddress": "string", // Item 1
  "MortPayment": 0.0, // Item 5
  "Investment": "string", // Not applicable with Lease Agreement
  "BorrowerName": "string",  // Not applicable with Lease Agreement
  "BorrowerBorrowerId": 0, // Link to borrower ID
  "TotalMortPayment": 0.0, // Output 
  "SchEovrd": "string", // Item 2: True = Lease; False = SchE
  "mthlyRent": 0.0, // Item 4
  "Y1Repairs": 0.0, // Not applicable with Lease Agreement
  "Y2Repairs": 0.0, // Not applicable with Lease Agreement
  "Y1Debts": 0.0, // Not applicable with Lease Agreement
  "Y2Debts": 0.0, // Not applicable with Lease Agreement
  "Y1RentRcvd": 0.0, // Not applicable with Lease Agreement
  "Y2RentRcvd": 0.0, // Not applicable with Lease Agreement
  "Y1RentMonths": 0.0, // Not applicable with Lease Agreement
  "Y2RentMonths": 0.0, // Not applicable with Lease Agreement
  "Y1ExpTotal": 0.0, // Not applicable with Lease Agreement
  "Y2ExpTotal": 0.0, // Not applicable with Lease Agreement
  "Y1InterestOther": 0.0, // Not applicable with Lease Agreement
  "Y2InterestOther": 0.0, // Not applicable with Lease Agreement
  "MortPayment2nd": 0.0, // Item 6
  "PropertyType": "string", // Item 3: Primary, Secondary, Rental, Other, or PrimaryRental
  "IsSubjectProperty": true, // Not applicable with Lease Agreement
  "Y1Line21": 0.0, // Not applicable with Lease Agreement
  "Y2Line21": 0.0, // Not applicable with Lease Agreement
  "useFullPITI": true, // Not applicable with Lease Agreement
  "DateAdded": "string",
  "comment": "string",
  "DateAddedUser": "string", 
  "LastModifiedUser": "string",
  "LastModifiedDate": "string", 
  "taxRate": 0.0, // Not applicable with Lease Agreement
  "finalNetIncome": 0.0, // Not applicable with Lease Agreement
  "netIncomeY1": 0.0, // Not applicable with Lease Agreement
  "netIncomeY2": 0.0 // Not applicable with Lease Agreement
}

Schedule E

{
  "REOincomeId": 0,
  "Y1TaxYear": 0.0, // Item 4
  "Y1Gain": 0.0, // Not applicable 
  "Y1Insurance": 0.0, // Item 7
  "Y1Interest": 0.0, // Item 8
  "Y1Taxes": 0.0, // Item 11
  "Y1Depreciation": 0.0, // Item 12
  "Y2Gain": 0.0, // Not applicable 
  "Y2Insurance": 0.0, // Item 7
  "Y2Interest": 0.0, // Item 8
  "Y2Taxes": 0.0, // Item 11
  "Y2Depreciation": 0.0, // Item 12
  "Y3Gain": 0.0, // Not applicable 
  "Y3Insurance": 0.0, // Not applicable
  "Y3Interest": 0.0, // Not applicable 
  "Y3Taxes": 0.0, // Not applicable
  "Y3Depreciation": 0.0, // Not applicable 
  "REOREOId": 0, // Not applicable
  "TnI_Inc": "string", // Item 18: No, Yes
  "Y1HOA": 0.0, // Not applicable 
  "Y2HOA": 0.0, // Not applicable 
  "Y3HOA": 0.0, // Not applicable 
  "RadioEnum": 0, // Not applicable 
  "finalIncome": 0.0, // Not applicable
  "CurrentTaxes": 0.0, // Item 19
  "CurrentHOI": 0.0, // Item 20
  "CurrentOther": 0.0, // Item 21
  "finalIncome_1YrAve": 0.0, // Output - Item 1
  "finalIncome_2YrAve": 0.0, // Output - Item 2
  "finalIncome_User": 0.0, // User radio button override - Item 3
  "StreetAddress": "string", // Item 1
  "MortPayment": 0.0, // Item 16
  "Investment": "string", // Not applicable
  "BorrowerName": "string",  // Not applicable
  "BorrowerBorrowerId": 0, // Link to borrower ID
  "TotalMortPayment": 0.0, // Output 
  "SchEovrd": "string", // Item 2: True = Lease; False = SchE
  "mthlyRent": 0.0, // Item 4
  "Y1Repairs": 0.0, // Item 10
  "Y2Repairs": 0.0, // Item 10
  "Y1Debts": 0.0, // Item 13
  "Y2Debts": 0.0, // Item 13
  "Y1RentRcvd": 0.0, // Item 6
  "Y2RentRcvd": 0.0, // Item 6
  "Y1RentMonths": 0.0, // Item 5
  "Y2RentMonths": 0.0, // Item 5
  "Y1ExpTotal": 0.0, // Item 14
  "Y2ExpTotal": 0.0, // Item 14
  "Y1InterestOther": 0.0, // Item 9
  "Y2InterestOther": 0.0, // Item 9
  "MortPayment2nd": 0.0, // Item 17
  "PropertyType": "string", // Item 3: Primary, Secondary, Rental, Other, or PrimaryRental
  "IsSubjectProperty": true, // Not applicable
  "Y1Line21": 0.0, // Item 15
  "Y2Line21": 0.0, // Item 15
  "useFullPITI": true, // Not applicable
  "DateAdded": "string",
  "comment": "string",
  "DateAddedUser": "string", 
  "LastModifiedUser": "string",
  "LastModifiedDate": "string", 
  "taxRate": 0.0, // Not applicable
  "finalNetIncome": 0.0, // Not applicable
  "netIncomeY1": 0.0, // Not applicable
  "netIncomeY2": 0.0 // Not applicable
}
Was this article helpful?

Related Articles

Popular Articles

Need Support?

Can’t find what you need?”