Updates a Scenario

patch

https://api.elliemae.com/loanOpportunity/v1/loanOpportunities/{opportunityId}/scenarios/{scenarioId}

Updates an existing scenario for an opportunity.

Path Params

opportunityId

string

required

The unique identifier of the opportunity to retrieve.

scenarioId

string

required

The unique identifier of the scenario to retrieve.

Body Params

dateCreated

date-time

The date and time the scenario was created.

dateModified

date-time

The date and time the scenario was modified.

dateStatusUpdated

date-time

The date and time the qualification status was last updated.

fee

object

Fee information provided by the LoanFeeContract object.

string

The unique, system-generated identifier of the scenario.

loanReferenceId

string

The ID to bind the entity in Loan.

qualificationStatus

string

The qualification status of the scenario.

qualifierSetting

object

Qualifier details provided by the QualifierSettingContract object.

scenarioCost

object

Scenario cost details provided by the ScenarioCostContract object.

scenarioIndicator

string

Scenario Indicator - A-Z.

terms

object

required

Required. Scenario term details provided by the ScenarioTermsContract object.

totalPayment

double

The total monthly payment for the scenario.

Headers

Authorization

string

required

Bearer token

Responses

202

Accepted

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error