V3 Manage Other Incomes

patch

https://api.elliemae.com/encompass/v3/loans/{loanId}/applications/{applicationId}/otherIncomeSources

Use this API to manage the Other Income Sources collection for an application at once. You can perform one of these operations in a single transaction on all the entries in this collection -

add to add new Other Income Sources
update to update existing Other Income Sources in the application
reorder to swap the order of the existing Other Income Sources in the application
delete to delete Other Income Sources entries from the application

Path Params

loanId

string

required

Unique identifier of the loan.

applicationId

string

required

Unique identifier of the Application or Borrower Pair in the loan for which VOOIs need to be retrieved..

Query Params

action

string

Action to be performed. Possible values are: add, update, reorder, delete.

Body Params

string

System-generated, unique identifier of other incomes in the loan

owner

string

Other Incomes owner

otherIncomeSourceDate

string

Other Income Source Date

printAttachmentIndicator

boolean

Indicates if "See attached borrower's authorization" on signature line." should be printed on the attachment

holderName

string

Name of the other incomes holder

attention

string

Attention Contact

holderAddressStreetLine1

string

Street Line 1 of the other incomes holder's address

holderAddressCity

string

City of the other incomes holder's address

holderAddressState

string

State of the other incomes holder's address

holderAddressPostalCode

string

Postal Code of the other incomes holder's address

holderPhone

string

Phone Number of the other incomes holder

holderFax

string

Fax Number of the other incomes holder

holderEmail

string

Email Address of the other incomes holder

title

string

Title of the user verifying the other incomes

printUserNameIndicator

boolean

Indicates if the user's name is to be printed

titlePhone

string

Phone Number of the user verifying the other incomes

titleFax

string

Fax number of the user verifying the other incomes

description

string

Description of Other Incomes. Possible Values are: AccessoryUnitIncome, Alimony, AutomobileAllowance, BoarderIncome, CapitalGains, ChildSupport, DefinedContributionPlan, Disability, DividendsInterest, EmploymentRelatedAccount, FosterCare, HousingAllowance, HousingChoiceVoucherProgram, MortgageCreditCertificate, MortgageDifferential, NonBorrowerHouseholdIncome, NotesReceivableInstallment, Other, Pension, PublicAssistance, Royalties, SeparateMaintenance, SocialSecurity, TemporaryLeave, TipIncome, Trust, Unemployment, VABenefitsNonEducational

otherDescription

string

Description of other income, if it is other than the pre-defined options.

foreignIncomeIndicator

boolean

Indicates if the income is foreign

seasonalIncomeIndicator

boolean

Indicates if the other Income is seasonal

monthlyAmount

number

Monthly amount from other income

printUserJobTitleIndicator

boolean

Job Title of the user verifying the other incomes

Headers

Authorization

string

required

Bearer token

Response

Language

URL

Response

Choose an example:

application/json

200OK