V3 Manage Employment

patch

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

This API can be used to manage the Employment collection for a borrower or coborrower under an application. You can perform one of these operations in a single transaction on all the entries in this collection:

add to add new employment records
update to update existing employment records in the application
reorder to swap the order of the existing employment records in the application
delete to delete employment records 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.

applicantType

string

required

Possible values are: borrower and coborrower.

Query Params

action

string

Action to be performed on the applicant's employment collection in a loan application. Possible values are: add, update, reorder, delete.

Body Params

string

System-generated, unique identifier of the Employment record.

addressCity

string

City of Employment.

addressPostalCode

string

Postal Code of Employment.

addressState

string

State of Employment.

addressStreetLine1

string

Address Street Line 1 of Employment.

attention

string

Attention To.

badgeOrEmployeeId

string

Unique ID of the Employee at the Employer organization.

basePayAmount

number

Base Pay Amount from this employment record.

bonusAmount

number

Bonus Amount from this employment.

businessName

string

Employer's Business Name.

businessOwnedPercent

number

Percentage of Business Owned by the applicant.

businessPhone

string

Business Phone Number.

commissionsAmount

number

Commission Amount from this employment.

countryCode

string

Country Code of Employment.

verificationDate

string

Date of Verification of Employment.

currentEmploymentIndicator

boolean

Indicates if this is the current employment record.

doesNotApply

boolean

Indicates if this employment does not apply.

string

Email address.

employerComments

string

Comments from Employer.

employerName

string

Name of the Employer.

employmentStartDate

string

Start Date of employment.

jobTermMonths

integer

Number of months in this job.

baseIncome

number

Base Income Amount.

overTime

number

Over Time Amount.

bonus

number

Bonus Amount.

commission

number

Commission Amount.

militaryEntitlement

number

Military Entitlement Amount.

otherIncome

number

Other Income Amount.

total

number

Total Amount from this Employment.

specialEmployerRelationshipIndicator

boolean

Indicates if there is a special relationship with the employer.

ownershipInterestType

string

Type of ownership interest.

employmentMonthlyIncomeAmount

number

Monthly Income Amount from this employment.

endDate

string

End Date of the employment if applicable.

fax

string

Fax Number of the employer.

monthlyIncomeAmount

integer

Monthly Income amount.

noLinkToDocTrackIndicator

boolean

Indicates if a corresponding verification document has been created for the employment record.

otherAmount

number

Other Amount.

overtimeAmount

number

Overtime Amount.

phoneNumber

string

Phone Number.

positionDescription

string

Description of the Employment Position.

printAttachmentIndicator

boolean

Indicates if the attachment should be printed.

printUserJobTitleIndicator

boolean

Indicates if the Job title of the user verifying the employment should be printed.

printUserNameIndicator

boolean

Indicates if the Name of the user verifying the employment should be printed.

selfEmployedIndicator

boolean

Indicates if the applicant is self-employed.

startDate

string

startDate of the employment.

timeInLineOfWorkMonths

integer

Number of months in this line of work.

timeInLineOfWorkYears

integer

Number of Years in this line of work.

timeOnJobTermMonths

integer

Number of Months on the job.

timeOnJobTermYears

integer

Number of Years on the job.

title

string

Job title.

titleFax

string

Fax Number.

titlePhone

string

Phone Number.

unitNumber

string

Unit Number of employment Address.

unitType

string

Unit Type of employment Address.

urla2020StreetAddress

string

Street Address of employment Address for URLA 2020 Application.

verificationRequestDate

string

Date on which verification was requested.

individualEmployer

boolean

Indicates of the employer is an individual.

militaryEmployer

boolean

Indicates of the employer is Military.

militaryCombatPay

number

Military Combat Pay.

militaryFlightPay

number

Military Flight Pay.

militaryHazardPay

number

Military Hazard Pay.

militaryOverseasPay

number

Military Overseas Pay.

militaryPropPay

number

Military Prop Pay.

clothingAllowance

number

Clothing Allowance Amount.

rationsAllowance

number

Rations Allowance Amount.

variableHousingAllowance

number

Variable Housing Allowance Amount.

quartersAllowance

number

Quarters Allowance Amount.

otherAllowanceDescription

string

Description of any other allowances.

foreignIncome

boolean

Indicates if there is a foreign income.

foreignAddressIndicator

boolean

Indicates if there is a foreign address for the employment.

country

string

Country of employment.

Headers

Authorization

string

required

Bearer token

Responses

400

Bad Request

Language

URL

Loading…

Response

Choose an example:

application/json

200OK