Escrow Analysis Module - Request

This section defines every object and field of the request payload for the Escrow module. Objects are documented in alphabetical order by parent object.

The request payload defines the payment stream structure for each response Schedule, and all the EscrowItem data that compose a funding Schedule in the response.

See the Legend to understand the conventions used to document each object and field. Note that for requests, the JSON objects are documented in alphabetical order by parent object.

🟥 Data

This required object is the root object for the Escrow request. Its child objects define the payment stream events for each Schedule[], and the individual EscrowItem[] objects composing each result Schedule.

Fields: None

Objects: 🟥 EscrowItem[], 🟦 Format, 🟥 PmtStream

🟥 Data.EscrowItem[]

This array of EscrowItem objects defines all escrow items included in result Schedule objects.

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

Objects: None

🔹 Data.EscrowItem.Category

To accommodate multiple EscrowItem objects that refer to the same funding schedule, a Category field is provided. If this field is not included, its value will default to the value of the Name field.

An example of this field becoming useful is when property tax is made with two payments. See the Sample Request.

🔸 Data.EscrowItem.Cost

The value of this required field 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.

🔹 Data.EscrowItem.CushionNo

The value of this optional field represents the number of monthly payments that must always exist in the funding 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.

🔸 Data.EscrowItem.Date

The value of this date field represents the date on which the escrow item must be paid in full.

🔸 Data.EscrowItem.Name

This value of this text field identifies the name of the escrow item being defined. If no Category is defined, this field will be the name of the funding Schedule disclosed in the response.

As with the Category field, the value of this field can be any text value except Aggregate, because every Schedule array in the response begins with a summary-schedule named Aggregate.

🟦 Data.Format

The Format object is one of the first objects parsed from a request, as various fields affect how date and numeric fields are parsed and validated.

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

Objects: None

🔹 Data.Format.CurrencyDecimals

When displaying and parsing Currency fields, this field determines the maximum number of decimal places allowed after the DecimalSeparator. If this field is not included, the default value is 2.

🔹 Data.Format.DateFormat

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

• YMD - All dates should be formated as YYYY-MM-DD.
• MDY - All dates should be formated as MM-DD-YYYY.
• DMY - All dates should be formated 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 field.

🔹 Data.Format.DateSeparator

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

🔹 Data.Format.DecimalSeparator

When displaying and parsing Currency, Percentage, or Floating numeric fields, this field determines the character used to separate the fractional part from the whole.

🔹 Data.Format.StrictDP

If the value of this field 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 field is set to 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.

🔹 Data.Format.ThousandSeparator

When displaying numeric fields, this field determines the character used to separate the thousands places from the hundreds. When parsing a numeric request field, if a thousand separator is specified in the request, then the SCE will now remove all occurrences of the specified thousand separator from the numeric field string before attempting to convert it to a number.

🟥 Data.PmtStream

The fields of this object define when the first payment is made and the frequency of payments. Each object, itself, is empty.

Fields: 🔸Date, 🔹PPY

Objects: None

🔸 Data.PmtStream.Date

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

🔹 Data.PmtStream.PPY

PPY or "payments per year" defines the frequency of payments in this optional field, which defaults to 12, or "monthly".