Escrow Analysis Module - Request

This section defines every element and attribute of the request payload for the Escrow module. Note that for requests, the XML elements are documented in alphabetical order by parent element.

The request payload defines the payment stream structure for each response <Schedule>, and all the <EscrowItem> data that compose a complete escrow analysis.

See the Legend to understand the conventions used to document each element and attribute. Note that for requests, the XML elements are documented in alphabetical order by parent element.

🟥 <inESCROW>

This required element is the root element for the Escrow request. Its child elements define the payment stream events for each <Schedule>, and the individual <EscrowItems> elements composing all result schedules.

Attributes: None

Elements: 🟥 <EscrowItem>[], 🟦 <Format>, 🟥 <PmtStream>

🟥 <EscrowItem>[]

<EscrowItem> elements are where all individual escrow items are defined, and must contain at least one item for the request to be valid. The attributes of an EscrowItem element define that item. If two or more items compose a single schedule, those items are linked through the Category attribute. See the sample Request for an example of two individual items being connected by the category attribute.

Attributes: 🔹Category, 🔸Cost, 🔹CushionNo, 🔸Date, 🔸Name

Elements: None

🔹 Category

To accommodate multiple <EscrowItem>s that refer to the same accounting schedule, a Category attribute is provided. If this attribute is not included, it's value will default to the value of the Name attribute.

An example of when this attribute becomes useful is when property tax is made with two payments. The code below illustrates this technique. Notice the same category being used to link the two individual escrow items.

   <EscrowItem
      Name="PropTax 1"
      Cost="7000.00"
      Category="Property Tax"
      Date="2026-07-25"
      CushionNo="2"
   />

   <EscrowItem
      Name="PropTax 2"
      Cost="5000.00"
      Category="Property Tax"
      Date="2026-11-25"
      CushionNo="2"
   />

As with the Name attribute, the value can be any text value except Aggregate, since every schedule in the response begins with a summary-schedule named Aggregate.

🔸 Cost

The value of this attribute represents the cost of the escrow item. This cost is divided by the number of payments per year to assess the amount of each <Schedule> periodic payment, Pmt, required of the customer to fund the escrow item.

🔹 CushionNo

The value of this optional attribute represents the number of monthly payments that must always exist in the cashflow schedule to assure a cash "cushion". As an example, if home insurance were $6000 per year, this amount results in a $6000 / 12 = $500 monthly payment. If the CushionNo entry were 2, the resulting cushion would be 2 * $500 = $1000.

🔸 Date

The date on which the escrow item must be paid in full.

🔸 Name

This value of this text attribute identifies the name of the escrow item being defined.

The value can be any text value except Aggregate, because every <Schedule> array in the response begins with a summary-schedule named Aggregate.

🟦 <Format>

The <Format> element is one of the first elements parsed from a request, as the attributes of this empty element affect how date and numeric values are parsed and validated.

Attributes: 🔹CurrencyDecimals, 🔹DateFormat, 🔹DateSeparator, 🔹DecimalSeparator, 🔹StrictDP, 🔹ThousandSeparator

Elements: None

🔹 CurrencyDecimals

When displaying and parsing Currency values, the value of this attribute determines the maximum number of decimal places allowed after the DecimalSeparator.

🔹 DateFormat

When displaying and parsing Date values, this field determines the expected format for all Date fields. The following DateFormat options are allowed:

• YMD - All dates should be formatted as YYYY-MM-DD.
• MDY - All dates should be formatted as MM-DD-YYYY.
• DMY - All dates should be formatted as DD-MM-YYYY.

Note that the character which separates the individual month, day, and year portions of the date is configurable via the DateSeparator attribute.

🔹 DateSeparator

When displaying and parsing Date values, this attribute determines the character used to separate the individual month, day, and year portions of a date.

🔹 DecimalSeparator

When displaying and parsing Currency or Decimal numeric values, this attribute determines the character used to separate the fractional part from the whole.

🔹 StrictDP

If the value of this attribute is true, then the SCE will strictly verify the number of decimal places allowed for currency input values. Thus, if the calling application sends in a request with a currency amount of 1000.005, the SCE will return an error code.

If the value of this attribute is false, then currency values sent in with an invalid number of decimal places will be rounded to the correct number of decimal places by the SCE (using five/four rounding), and a warning message with this information will be returned with the response.

🔹 ThousandSeparator

When displaying numeric values, this attribute determines the character used to separate the thousands places from the hundreds. Note that when parsing numeric values, the value of this attribute is ignored.

🟥 <PmtStream>

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

Attributes: 🔸Date, 🔹PPY

Elements: None

🔸 Date

The date of the first payment is entered as the value of this attribute.

🔹 PPY

PPY or "payments per year" defines the frequency of payments.