Escrow Analysis Module - Response

The results of the Escrow Analysis module calculation are contained in the response XML payload, and represent various periodic schedules of payments with associated data. All response payloads will contain a schedule named Aggregate, which represents all escrow item payoff information.

Please see the Legend to understand the conventions used to document each element and attribute. Note that for responses, the XML elements are documented in the order that they appear in the response.

🟥 <outESCROW>

This is the root element of the XML response, and is required. This element simply acts as a container for all of the result child elements.

Attributes: None

Elements: 🟥 <Results>, 🟥 <Schedule>[]

🟥 <Results>

This element contains child elements which describe the success or failure of the calculation, as well as any XML messages.

Attributes: None

🟥 <Description>, 🟦 <XMLDetail>[]

🟥 <Results>→<Description>

If the calculation was completed successfully, then this element will contain the value Successful Calculation. Otherwise, this element will contain a description of the problem encountered during the attempted computation.

Attributes: None

Elements: None

🟦 <Results>→<XMLDetail>[]

The <XMLDetail> elements are messages passed back to the calling application which detail the status of the request. If the SCE issues any warnings regarding unrecognized elements or attributes, then each warning message will be displayed in an <XMLDetail> element.

Attributes: None

Elements: None

🟦 <Schedule>[]

The attributes of this element define when the first payment is made and the frequency of payments. The element, itself, is empty.

Attributes: 🔸Category, 🔸Pmt, 🔸NumPmts, 🔸Cushion, 🔸Closing, 🔸Slush, 🔹Adjustment

Elements: 🟥 Event[]

🔸 Category

This attribute shows the category name of the schedule, which corresponds directly with associated escrow items. See the Category attribute of the corresponding <EscrowItem> for more information on naming conventions.

🔸 Pmt

The value of this required attribute reprents the sum of each payment of the <EscrowItem>'s bearing the associated Category value.

🔸 NumPmts

The number of payments required to meet Cushion and Closing requirements is reported in the value of this attribute.

🔸 Cushion

The currency value of the total cushion required in the <EscrowItem>'s CushionNo is reported in the value of this attribute.

🔸 Closing

The currency value of the total associated closing costs required to fund the escrow items associated with this <Schedule> is reported in the value of this attribute.

🔸 Slush

Because the payments funding this schedule are rounded up, the sum of these payments and the total escrow item costs is not the same. The difference in these two values is reported as the value of this attribute.

e.g. An escrow item of $1,000 has a monthly payment of $83.34. The sum of all these payments is 1000.08, so the Slush attribute would report 0.08 as its value.

🔹 Adjustment

The value of this attribute recognizes a difference that can arise between the aggregate closing cost and the sum of individual closing costs for each schedule. Adjustment, therefore, only appears in the Aggregate schedule, and represents the difference between the closing cost recorded in the Aggregate schedule and the sum of all other individual schedules.

🟥 <Event>[]

The attributes of this element define the events relevant to a schedule.

Attributes: 🔸Date, 🔸Name, 🔸BegBal, 🔸Amt, 🔸EndBal

Elements: None

🔸 Date

The value of this YYYY-MM-DD formatted attribute represents the date of a scheduled event. If a payment and cost occur on the same date, the payment is listed first, since payments fund escrow item costs.

🔸 Name

The value of this text attribute is either Pmt for a payment event or the name the escrow item to which it refers.

🔸 BegBal

The value of this currency attribute represents the cumulative cash value of the initial closing cost modified by the previous events.

🔸 Amt

The value of this currency attribute represents the value of the event's contribution to the running balance. If the event is a payment, the value of this attribute is positive, representing money coming in to the escrow company; otherwise, the value is negative, representing the payment of an escrow item.

🔸 EndBal

The value of this currency attribute represents the result of the event on the running balance of the schedule.