Read an escrow analysis and statement content

GET/loans/{id}/escrow/analyses/{analysis}

Path parameters

idstringRequired

analysisstringRequired

Returns

200 OK

actorstringRequired

analysisobjectRequired

14 child attributes

actual_balanceintegerRequired

annual_disbursementsintegerRequired

base_monthlyintegerRequired

deficiencyintegerRequired

deficiency_optionsarray of objectsRequired

3 child attributes

due_daysintegerOptional

methodstringRequired

minimum_monthsintegerOptional

inputobjectRequired

3 child attributes

first_paymentstring · dateRequired

A business date, YYYY-MM-DD

itemsarray of objectsRequired

5 child attributes

amountintegerRequired

datestring · dateRequired

A business date, YYYY-MM-DD

evidencestringRequired

payeestringRequired

purposestringRequired

policyobjectRequired

3 child attributes

cushionintegerRequired

cushion_limitintegerRequired

referencestringRequired

monthsarray of objectsRequired

5 child attributes

balanceintegerRequired

disbursementsintegerRequired

paymentintegerRequired

payment_datestring · dateRequired

A business date, YYYY-MM-DD

target_limitintegerRequired

opening_targetintegerRequired

rounding_undercollectionintegerRequired

shortageintegerRequired

shortage_optionsarray of objectsRequired

3 child attributes

due_daysintegerOptional

methodstringRequired

minimum_monthsintegerOptional

surplusintegerRequired

surplus_optionsarray of objectsRequired

3 child attributes

due_daysintegerOptional

methodstringRequired

minimum_monthsintegerOptional

unfunded_targetintegerRequired

bankobjectRequired

5 child attributes

addressstringRequired

error_noticestringRequired

localbooleanRequired

namestringRequired

phonestringRequired

customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

datestring · dateRequired

A business date, YYYY-MM-DD

historyarray of objectsRequired

5 child attributes

amountintegerRequired

datestring · dateRequired

A business date, YYYY-MM-DD

payeestringRequired

purposestringRequired

referencestringRequired

idstringRequired

initial_depositintegerRequired

kindstringRequired

loan_idstringRequired

Example loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm

monthly_escrowintegerRequired

monthly_mortgageintegerRequired

opening_balanceintegerRequired

paid_out_by_purposearray of objectsRequired

2 child attributes

amountintegerRequired

purposestringRequired

payment_effective_datestring · dateRequired

A business date, YYYY-MM-DD

period_endstring · date or nullOptional

A business date, YYYY-MM-DD

period_startstring · date or nullOptional

A business date, YYYY-MM-DD

planobjectRequired

4 child attributes

lump_sumintegerRequired

paymentsarray of objectsRequired

6 child attributes

baseintegerRequired

creditintegerRequired

datestring · dateRequired

A business date, YYYY-MM-DD

deficiencyintegerRequired

shortageintegerRequired

totalintegerRequired

refundintegerRequired

retainedintegerRequired

principal_and_interestintegerRequired

prior_analysisobject or nullOptional

14 child attributes

actual_balanceintegerRequired

annual_disbursementsintegerRequired

base_monthlyintegerRequired

deficiencyintegerRequired

deficiency_optionsarray of objectsRequired

3 child attributes

due_daysintegerOptional

methodstringRequired

minimum_monthsintegerOptional

inputobjectRequired

3 child attributes

first_paymentstring · dateRequired

A business date, YYYY-MM-DD

itemsarray of objectsRequired

5 child attributes

amountintegerRequired

datestring · dateRequired

A business date, YYYY-MM-DD

evidencestringRequired

payeestringRequired

purposestringRequired

policyobjectRequired

3 child attributes

cushionintegerRequired

cushion_limitintegerRequired

referencestringRequired

monthsarray of objectsRequired

5 child attributes

balanceintegerRequired

disbursementsintegerRequired

paymentintegerRequired

payment_datestring · dateRequired

A business date, YYYY-MM-DD

target_limitintegerRequired

opening_targetintegerRequired

rounding_undercollectionintegerRequired

shortageintegerRequired

shortage_optionsarray of objectsRequired

3 child attributes

due_daysintegerOptional

methodstringRequired

minimum_monthsintegerOptional

surplusintegerRequired

surplus_optionsarray of objectsRequired

3 child attributes

due_daysintegerOptional

methodstringRequired

minimum_monthsintegerOptional

unfunded_targetintegerRequired

prior_monthly_escrowintegerRequired

prior_monthly_mortgageintegerRequired

resolutionobjectRequired

4 child attributes

deficiencyobjectRequired

2 child attributes

methodstringRequired

monthsintegerOptional

evidencestringRequired

shortageobjectRequired

2 child attributes

methodstringRequired

monthsintegerOptional

surplusstringOptional

submission_deadlinestring · dateRequired

A business date, YYYY-MM-DD

total_paid_inintegerRequired

total_paid_outintegerRequired

variance_explanationstringOptional

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503