Compliance Calendar Date Calculator Request Contract
The following attributes and objects make up the CalculatorRequest contract.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| completionBasis object | Required. Object containing the Ecompass loan data and Calendar Settings used to calculate the completion date/time. |
| dateSrc string | Required. Object containing the source data used for the Completion Date calculation. The source data will identify the starting point used in the calculation. |
| dateSrc.source string | Required. The source that will be used, either "event" or "loan". When dateSrc.source = loan, an Encompass loan and date field value will be used. When dateSrc.source = event, a specified date/time value in the request payload will be used. |
| dateSrc.eventDate date/time | Conditional when dateSrc.source=event. Format is in UTC date/time value. When source=event, input the date/time you want to use as the starting point for the calculation, in UTC date/time format. |
| dateSrc.loanId string | Conditional when dateSrc.source=loan. The loanId of the Encompass Loan. When source=loan, you must provide an Encompass loan to use. |
| dateSrc.fieldKey string | Conditional when dateSrc.source=loan. The Field ID of the date field you wish to use. When source=loan, you must provide Date Field ID. The calculator will use the value in this field, on the specified Encompass loan, as the starting point of the calculation. |
| calendar string | Calendar to be used for the completion date calculation. Note: When not provided, the default calendar used is "AllDays". Values are following: - Postal - U.S Postal Calendar - Business - Our Company Calendar - Custom - Custom Lock Desk Calendar - RegZ - Reg-Z Business Day Calendar - AllDays - No Encompass Calendar is used. Full 365/366 day calendar. |
| offset integer | Required. Positive, or negative, number of days to add or subtract from the source date. |
| startFromClosestBusinessDay boolean | Indicate what to do when the source date is on a non-business day per the calendar specified. - Specify 'True' if the source date (starting point) is on a non-business day, then move the starting point to the closest business day. (This is the default value) - Specify 'False' to use whatever source date is provided, even when it is on a non-business day. |
| timezoneCode string | Required. Time Zone. The default is time zone for the Encompass instance. Note: This is a known issue and will be fixed in a future release to be a default value of UTC. Values are the following: - UTC - Coordinated Universal Time - HST - Hawaii Time - AKT - Alaska Time - PT - Pacific Time - MST - Arizona Time - MT - Mountain Time - CT - Central Time - ET - Eastern Time Local |
| timeOfDay string | Required. Time of Day. 24-hour clock, to the minute. Default value is 00:00. |
© ICE Mortgage Technology, Inc. All rights reserved.