Update Rate Lock

An integration listed under the Product & Pricing Engine (PPE) category can update a rate lock by creating a transaction with a response that returns the required field values, and with a response result object with the action UPDATE. Within the same transaction response, the integration can also send additional loan data to be updated in Encompass. The specific fields that are sent as part of the response loan data follow the standard data entitlement model and process. However, not all of the loan data fields that are sent inside the loan attribute are saved as part of the lock snapshot.

📘

Schema versions

This page documents application/vnd.productpricing-update-1.0.0.json. Version 2.0.0 (application/vnd.productpricing-update-2.0.0.json) uses ISO dates, typed adjustment arrays, and a required id. See Update Rate Lock v2.

{
   "status": "completed",
   "loanFormat": "application/vnd.plm-2.0.0+json",
   "loan": {
      ... // Additional loan data, sent as part of standard transaction loan update
   },
   "result": {
      "format": "application/vnd.productpricing-update-1.0.0.json",
      "action": "UPDATE",
      "details": {
         ... // Update rate lock action details
      }
   },
   "partnerStatus": "partner status",
   "respondingParty": {
      "name": "PPE partner",
      "address": "P.O. BOX 509124, SUITE 300",
      "city": "SAN DIEGO",
      "state": "CA",
      "postalCode": "92150",
      "pointOfContact": {
         "fax": "8002376526",
         "phone": "8009864343",
         "email": "[email protected]"
      }
   },
   "referenceNumber": "000901"
}

lockId is optional and identifies the rate lock to update. The buySide, sellSide, and comparison objects carry the updated values for each side of the lock. Dates use the MM/DD/YYYY format.

The complete list of supported fields in the update rate lock request action details object is defined in the JSON schema below. You can use online tools such as JSON Schema Validator to manually validate the contents of a details object.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "validationMessage": {
    "oneOfAdditionalFields": "fieldName and one of stringValue, numericValue and dateValue is required.",
    "datePattern": "Date should be in the format MM/DD/YYYY.",
    "uuidPattern": "UUID. It must be a valid UUID format"
  },
  "properties": {
    "copyLoanData": {
      "type": "boolean",
      "description": "When true, copies loan data from the loan to the pricing request."
    },
    "dataSyncOption": {
      "type": "string",
      "enum": [
        "NoSync",
        "syncLockToLoan"
      ],
      "description": "Specifies the data synchronization option between the rate lock and the loan."
    },
    "lockId": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "validationMessage": {
        "$ref": "#/validationMessage/uuidPattern"
      }
    },
    "buySide": {
      "type": "object",
      "properties": {
        "commitment": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "Best Efforts",
                "Mandatory"
              ]
            },
            "number": {
              "type": "string",
              "description": "Commitment number associated with the trade."
            },
            "date": {
              "$ref": "#/definitions/datePattern",
              "description": ""
            },
            "masterCommitmentNumber": {
              "type": "string",
              "description": "Master commitment number associated with the trade."
            },
            "investorCommitment": {
              "type": "string",
              "description": ""
            }
          },
          "additionalProperties": false
        },
        "onrpDate": {
          "$ref": "#/definitions/datePattern",
          "description": ""
        },
        "onrpEligible": {
          "type": "boolean",
          "description": ""
        },
        "tpoName": {
          "type": "string",
          "description": ""
        },
        "tpoId": {
          "type": "string",
          "description": ""
        },
        "orgId": {
          "type": "string",
          "description": ""
        },
        "daysToExtend": {
          "$ref": "#/definitions/integerField"
        },
        "extendedLockExpirationDate": {
          "$ref": "#/definitions/datePattern"
        },
        "lockExtendPriceAdjustment": {
          "$ref": "#/definitions/numericField"
        },
        "expirationDate": {
          "$ref": "#/definitions/datePattern",
          "description": ""
        },
        "originalLockExpirationDate": {
          "$ref": "#/definitions/datePattern"
        },
        "investor": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "Name of the investor."
            }
          },
          "additionalProperties": false
        },
        "delivery": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "description": ""
            },
            "expirationDate": {
              "$ref": "#/definitions/datePattern",
              "description": ""
            }
          },
          "additionalProperties": false
        },
        "totalBuyPrice": {
          "$ref": "#/definitions/numericField",
          "description": ""
        },
        "totalPrice": {
          "$ref": "#/definitions/numericField",
          "description": ""
        },
        "startingAdjustPrice": {
          "$ref": "#/definitions/numericField",
          "description": ""
        },
        "unDiscountedRate": {
          "$ref": "#/definitions/numericField",
          "description": ""
        },
        "totalRateAdjustments": {
          "$ref": "#/definitions/numericField",
          "description": ""
        },
        "netRate": {
          "$ref": "#/definitions/numericField",
          "description": ""
        },
        "totalPriceAdjustments": {
          "$ref": "#/definitions/numericField",
          "description": ""
        },
        "netPrice": {
          "$ref": "#/definitions/numericField",
          "description": ""
        },
        "totalMarginAdjustments": {
          "$ref": "#/definitions/numericField",
          "description": ""
        },
        "netMarginRate": {
          "$ref": "#/definitions/numericField",
          "description": ""
        },
        "startingAdjustRate": {
          "$ref": "#/definitions/numericField",
          "description": ""
        },
        "branch": {
          "type": "object",
          "properties": {
            "approvalDate": {
              "$ref": "#/definitions/datePattern",
              "description": ""
            },
            "approvedBy": {
              "type": "string",
              "description": ""
            },
            "price": {
              "$ref": "#/definitions/numericField",
              "description": ""
            },
            "reasonForApproval": {
              "type": "string",
              "description": ""
            },
            "approvalDate2": {
              "$ref": "#/definitions/datePattern",
              "description": ""
            },
            "approvedBy2": {
              "type": "string",
              "description": ""
            },
            "price2": {
              "$ref": "#/definitions/numericField",
              "description": ""
            },
            "reasonForApproval2": {
              "type": "string",
              "description": ""
            },
            "approvalDate3": {
              "$ref": "#/definitions/datePattern",
              "description": ""
            },
            "approvedBy3": {
              "type": "string",
              "description": ""
            },
            "price3": {
              "$ref": "#/definitions/numericField",
              "description": ""
            },
            "reasonForApproval3": {
              "type": "string",
              "description": ""
            },
            "approvalDate4": {
              "$ref": "#/definitions/datePattern",
              "description": ""
            },
            "approvedBy4": {
              "type": "string",
              "description": ""
            },
            "price4": {
              "$ref": "#/definitions/numericField",
              "description": ""
            },
            "reasonForApproval4": {
              "type": "string",
              "description": ""
            },
            "approvalDate5": {
              "$ref": "#/definitions/datePattern",
              "description": ""
            },
            "approvedBy5": {
              "type": "string",
              "description": ""
            },
            "price5": {
              "$ref": "#/definitions/numericField",
              "description": ""
            },
            "reasonForApproval5": {
              "type": "string",
              "description": ""
            }
          },
          "additionalProperties": false
        },
        "corporate": {
          "type": "object",
          "properties": {
            "approvalDate": {
              "$ref": "#/definitions/datePattern",
              "description": ""
            },
            "approvedBy": {
              "type": "string",
              "description": ""
            },
            "price": {
              "$ref": "#/definitions/numericField",
              "description": ""
            },
            "reasonForApproval": {
              "type": "string",
              "description": ""
            },
            "approvalDate2": {
              "$ref": "#/definitions/datePattern",
              "description": ""
            },
            "approvedBy2": {
              "type": "string",
              "description": ""
            },
            "price2": {
              "$ref": "#/definitions/numericField",
              "description": ""
            },
            "reasonForApproval2": {
              "type": "string",
              "description": ""
            },
            "approvalDate3": {
              "$ref": "#/definitions/datePattern",
              "description": ""
            },
            "approvedBy3": {
              "type": "string",
              "description": ""
            },
            "price3": {
              "$ref": "#/definitions/numericField",
              "description": ""
            },
            "reasonForApproval3": {
              "type": "string",
              "description": ""
            },
            "approvalDate4": {
              "$ref": "#/definitions/datePattern",
              "description": ""
            },
            "approvedBy4": {
              "type": "string",
              "description": ""
            },
            "price4": {
              "$ref": "#/definitions/numericField",
              "description": ""
            },
            "reasonForApproval4": {
              "type": "string",
              "description": ""
            },
            "approvalDate5": {
              "$ref": "#/definitions/datePattern",
              "description": ""
            },
            "approvedBy5": {
              "type": "string",
              "description": ""
            },
            "price5": {
              "$ref": "#/definitions/numericField",
              "description": ""
            },
            "reasonForApproval5": {
              "type": "string",
              "description": ""
            }
          },
          "additionalProperties": false
        },
        "profitMarginAdjustedBuyPrice": {
          "$ref": "#/definitions/numericField"
        },
        "correspondent": {
          "type": "object",
          "properties": {
            "tradeId": {
              "type": "string",
              "description": ""
            },
            "tradeNumber": {
              "type": "string",
              "description": ""
            }
          },
          "additionalProperties": false
        },
        "lockDate": {
          "$ref": "#/definitions/datePattern",
          "description": ""
        },
        "lockExpirationDate": {
          "$ref": "#/definitions/datePattern",
          "description": ""
        },
        "lockNumberOfDays": {
          "$ref": "#/definitions/integerField",
          "description": ""
        },
        "baseRate": {
          "$ref": "#/definitions/numericField",
          "description": ""
        },
        "basePrice": {
          "$ref": "#/definitions/numericField"
        },
        "baseMarginRate": {
          "$ref": "#/definitions/numericField",
          "description": ""
        },
        "srpPaidOut": {
          "$ref": "#/definitions/numericField",
          "description": ""
        },
        "rateSheetId": {
          "type": "string",
          "description": ""
        },
        "lastRateSetDate": {
          "$ref": "#/definitions/datePattern",
          "description": ""
        },
        "comments": {
          "type": "string",
          "description": ""
        },
        "adjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustmentItem"
          },
          "minItems": 1,
          "description": ""
        }
      },
      "additionalProperties": false
    },
    "sellSide": {
      "type": "object",
      "properties": {
        "srp": {
          "$ref": "#/definitions/numericField"
        },
        "servicing": {
          "$ref": "#/definitions/servicingItem"
        },
        "actual": {
          "type": "object",
          "properties": {
            "amount": {
              "$ref": "#/definitions/numericField"
            },
            "price": {
              "$ref": "#/definitions/numericField"
            },
            "srp": {
              "$ref": "#/definitions/numericField"
            }
          },
          "additionalProperties": false
        },
        "diff": {
          "type": "object",
          "properties": {
            "amount": {
              "$ref": "#/definitions/numericField"
            },
            "price": {
              "$ref": "#/definitions/numericField"
            },
            "srp": {
              "$ref": "#/definitions/numericField"
            }
          },
          "additionalProperties": false
        },
        "netAmount": {
          "$ref": "#/definitions/numericField"
        },
        "paidMiPremium": {
          "$ref": "#/definitions/numericField"
        },
        "tradeMgmtPrevConfirmedLockGuid": {
          "type": "string",
          "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
          "validationMessage": {
            "$ref": "#/validationMessage/uuidPattern"
          }
        },
        "correspondent": {
          "type": "object",
          "properties": {
            "escrowDisbursementsToBePaid": {
              "$ref": "#/definitions/numericField"
            },
            "tradeId": {
              "type": "string"
            },
            "tradeNumber": {
              "type": "string"
            }
          },
          "additionalProperties": false
        },
        "daysToExtend": {
          "$ref": "#/definitions/integerField"
        },
        "extendedLockExpirationDate": {
          "$ref": "#/definitions/datePattern"
        },
        "commitmentDate": {
          "$ref": "#/definitions/datePattern"
        },
        "lockExtendPriceAdjustment": {
          "$ref": "#/definitions/numericField"
        },
        "discountYsp": {
          "$ref": "#/definitions/numericField"
        },
        "masterContractNumber": {
          "type": "string"
        },
        "gainLossPercentage": {
          "$ref": "#/definitions/numericField"
        },
        "gainLossPrice": {
          "$ref": "#/definitions/numericField"
        },
        "gainLossTotalPrice": {
          "$ref": "#/definitions/numericField"
        },
        "rateSheetId": {
          "type": "string"
        },
        "lastRateSetDate": {
          "$ref": "#/definitions/datePattern"
        },
        "lockNumberOfDays": {
          "$ref": "#/definitions/integerField"
        },
        "lockExpirationDate": {
          "$ref": "#/definitions/datePattern"
        },
        "lockDate": {
          "$ref": "#/definitions/datePattern"
        },
        "baseRate": {
          "$ref": "#/definitions/numericField"
        },
        "totalRateAdjustments": {
          "$ref": "#/definitions/numericField"
        },
        "netRate": {
          "$ref": "#/definitions/numericField"
        },
        "basePrice": {
          "$ref": "#/definitions/numericField"
        },
        "totalPriceAdjustments": {
          "$ref": "#/definitions/numericField"
        },
        "netPrice": {
          "$ref": "#/definitions/numericField"
        },
        "baseMarginRate": {
          "$ref": "#/definitions/numericField"
        },
        "totalMarginAdjustments": {
          "$ref": "#/definitions/numericField"
        },
        "netMarginRate": {
          "$ref": "#/definitions/numericField"
        },
        "originalLockExpirationDate": {
          "$ref": "#/definitions/datePattern"
        },
        "comments": {
          "type": "string"
        },
        "srpPaidOut": {
          "$ref": "#/definitions/numericField"
        },
        "investor": {
          "type": "object",
          "properties": {
            "loanNumber": {
              "type": "string"
            },
            "mersNumber": {
              "type": "string"
            },
            "lockedDate": {
              "$ref": "#/definitions/datePattern"
            },
            "deliveryDate": {
              "$ref": "#/definitions/datePattern"
            },
            "targetDeliveryDate": {
              "$ref": "#/definitions/datePattern"
            },
            "name": {
              "type": "string"
            },
            "contact": {
              "type": "string"
            },
            "phone": {
              "type": "string"
            },
            "email": {
              "type": "string"
            },
            "address": {
              "type": "string"
            },
            "city": {
              "type": "string"
            },
            "state": {
              "type": "string",
              "maxLength": 2
            },
            "postalCode": {
              "type": "string"
            },
            "website": {
              "type": "string"
            },
            "lockType": {
              "type": "string"
            },
            "programCode": {
              "type": "string"
            },
            "status": {
              "type": "string"
            },
            "statusDate": {
              "$ref": "#/definitions/datePattern"
            },
            "tradeNumber": {
              "type": "string"
            },
            "commitment": {
              "type": "string"
            },
            "templateName": {
              "type": "string"
            }
          },
          "additionalProperties": false
        },
        "adjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustmentItem"
          },
          "minItems": 1,
          "description": ""
        }
      },
      "additionalProperties": false
    },
    "comparison": {
      "type": "object",
      "properties": {
        "servicingType": {
          "type": "string",
          "enum": [
            "Service Retained",
            "Service Released"
          ]
        },
        "discountYsp": {
          "$ref": "#/definitions/numericField"
        },
        "masterContractNumber": {
          "type": "string"
        },
        "gainLossPercentage": {
          "$ref": "#/definitions/numericField"
        },
        "gainLossPrice": {
          "$ref": "#/definitions/numericField"
        },
        "gainLossTotalPrice": {
          "$ref": "#/definitions/numericField"
        },
        "rateSheetId": {
          "type": "string"
        },
        "lastRateSetDate": {
          "$ref": "#/definitions/datePattern"
        },
        "lockNumberOfDays": {
          "$ref": "#/definitions/integerField"
        },
        "lockExpirationDate": {
          "$ref": "#/definitions/datePattern"
        },
        "lockDate": {
          "$ref": "#/definitions/datePattern"
        },
        "baseRate": {
          "$ref": "#/definitions/numericField"
        },
        "totalRateAdjustments": {
          "$ref": "#/definitions/numericField"
        },
        "netRate": {
          "$ref": "#/definitions/numericField"
        },
        "basePrice": {
          "$ref": "#/definitions/numericField"
        },
        "totalPriceAdjustments": {
          "$ref": "#/definitions/numericField"
        },
        "netPrice": {
          "$ref": "#/definitions/numericField"
        },
        "baseMarginRate": {
          "$ref": "#/definitions/numericField"
        },
        "totalMarginAdjustments": {
          "$ref": "#/definitions/numericField"
        },
        "netMarginRate": {
          "$ref": "#/definitions/numericField"
        },
        "comments": {
          "type": "string"
        },
        "originalLockExpirationDate": {
          "$ref": "#/definitions/datePattern"
        },
        "srpPaidOut": {
          "$ref": "#/definitions/numericField"
        },
        "investor": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string"
            },
            "contact": {
              "type": "string"
            },
            "phone": {
              "type": "string"
            },
            "email": {
              "type": "string"
            },
            "address": {
              "type": "string"
            },
            "city": {
              "type": "string"
            },
            "state": {
              "type": "string",
              "maxLength": 2
            },
            "postalCode": {
              "type": "string"
            },
            "website": {
              "type": "string"
            },
            "lockType": {
              "type": "string"
            },
            "programCode": {
              "type": "string"
            },
            "status": {
              "type": "string"
            },
            "statusDate": {
              "$ref": "#/definitions/datePattern"
            },
            "tradeNumber": {
              "type": "string"
            },
            "commitment": {
              "type": "string"
            },
            "templateName": {
              "type": "string"
            }
          },
          "additionalProperties": false
        },
        "adjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustmentItem"
          },
          "minItems": 1,
          "description": ""
        }
      },
      "additionalProperties": false
    },
    "additionalFields": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/additionalFieldItem"
      },
      "minItems": 1,
      "description": "Additional fields in the rate lock."
    }
  },
  "additionalProperties": false,
  "definitions": {
    "integerField": {
      "type": "integer",
      "minimum": 1
    },
    "numericField": {
      "type": "number",
      "multipleOf": 0.0000000001
    },
    "adjustmentNumericField": {
      "type": "number",
      "multipleOf": 0.0000000001
    },
    "datePattern": {
      "type": "string",
      "pattern": "^^(?:(?:(?:0?[13578]|1[02])(\\/)31)\\1|(?:(?:0?[1,3-9]|1[0-2])(\\/)(?:29|30)\\2))(?:(?:1[6-9]|[2-9]\\d)?\\d{2})$|^(?:0?2(\\/)29\\3(?:(?:(?:1[6-9]|[2-9]\\d)?(?:0[48]|[2468][048]|[13579][26])|(?:(?:16|[2468][048]|[3579][26])00))))$|^(?:(?:0?[1-9])|(?:1[0-2]))(\\/)(?:0?[1-9]|1\\d|2[0-8])\\4(?:(?:1[6-9]|[2-9]\\d)?\\d{2})$",
      "validationMessage": {
        "$ref": "#/validationMessage/datePattern"
      }
    },
    "servicingItem": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "Service Retained",
            "Service Released"
          ],
          "description": ""
        },
        "servicer": {
          "type": "string"
        },
        "fee": {
          "type": "object",
          "properties": {
            "servicing": {
              "$ref": "#/definitions/numericField"
            },
            "guarantyBase": {
              "$ref": "#/definitions/numericField"
            },
            "guarantee": {
              "$ref": "#/definitions/numericField"
            }
          },
          "additionalProperties": false
        },
        "pool": {
          "type": "object",
          "properties": {
            "number": {
              "type": "string"
            },
            "id": {
              "type": "string"
            }
          },
          "additionalProperties": false
        },
        "commitmentContractNumber": {
          "type": "string"
        },
        "productName": {
          "type": "string"
        },
        "msrValue": {
          "$ref": "#/definitions/numericField"
        }
      },
      "additionalProperties": false
    },
    "adjustmentItem": {
      "type": "object",
      "properties": {
        "adjustmentType": {
          "type": "string",
          "enum": [
            "Adjustment",
            "LockExtensionAdjustment",
            "ReLockFeeAdjustment",
            "CustomPriceAdjustment"
          ],
          "description": ""
        },
        "description": {
          "type": "string",
          "description": ""
        },
        "priceAdjustmentType": {
          "type": "string",
          "enum": [
            "BasePrice",
            "BaseMargin",
            "BaseRate",
            "ProfitMargin"
          ],
          "description": ""
        },
        "adjustment": {
          "$ref": "#/definitions/adjustmentNumericField",
          "description": ""
        }
      },
      "required": [
        "adjustmentType",
        "description",
        "priceAdjustmentType"
      ],
      "additionalProperties": false
    },
    "additionalFieldItem": {
      "type": "object",
      "properties": {
        "fieldName": {
          "type": "string",
          "minLength": 1,
          "pattern": "^[a-zA-Z0-9.]*$",
          "description": "Identifier of the additional field in encompass"
        },
        "numericValue": {
          "type": "number",
          "multipleOf": 0.0000000001,
          "description": "Numeric value for the additional field"
        },
        "stringValue": {
          "type": "string",
          "minLength": 1,
          "description": "String value for the additional field"
        },
        "dateValue": {
          "$ref": "#/definitions/datePattern",
          "description": "Date value for the additional field."
        }
      },
      "oneOf": [
        {
          "required": [
            "fieldName",
            "stringValue"
          ],
          "validationMessage": {
            "$ref": "#/validationMessage/oneOfAdditionalFields"
          }
        },
        {
          "required": [
            "fieldName",
            "numericValue"
          ],
          "validationMessage": {
            "$ref": "#/validationMessage/oneOfAdditionalFields"
          }
        },
        {
          "required": [
            "fieldName",
            "dateValue"
          ],
          "validationMessage": {
            "$ref": "#/validationMessage/oneOfAdditionalFields"
          }
        }
      ],
      "additionalProperties": false
    }
  }
}

Below is a sample update rate lock request payload with most of the fields supported in the update rate lock request operation:

{
  "status": "completed",
  "result": {
    "format": "application/vnd.productpricing-update-1.0.0.json",
    "action": "UPDATE",
    "details": {
      "lockId": "c669557c-d631-427d-a6f8-94ef1922db1d",
      "copyLoanData": false,
      "dataSyncOption": "syncLockToLoan",
      "buySide": {
        "commitment": {
          "type": "Best Efforts",
          "number": "4544534",
          "masterCommitmentNumber": "342432"
        },
        "expirationDate": "07/21/2020",
        "delivery": {
          "type": "Bulk",
          "expirationDate": "07/21/2020"
        },
        "startingAdjustPrice": 1.3,
        "unDiscountedRate": 1.1,
        "startingAdjustRate": 1.2,
        "branch": {
          "approvalDate": "07/08/2020",
          "approvedBy": "Jane Doe",
          "price": 0.125,
          "reasonForApproval": "Branch pricing exception"
        },
        "corporate": {
          "approvalDate": "07/08/2020",
          "approvedBy": "John Doe",
          "price": 0.25,
          "reasonForApproval": "Competitive match"
        },
        "profitMarginAdjustedBuyPrice": 0.26,
        "correspondent": {
          "tradeId": "3242",
          "tradeNumber": "Trade-1234"
        },
        "lockDate": "07/07/2020",
        "lockExpirationDate": "07/21/2020",
        "baseRate": 4.3,
        "basePrice": 99.5,
        "baseMarginRate": 2.25,
        "rateSheetId": "RS9110",
        "lastRateSetDate": "05/07/2020",
        "srpPaidOut": 1.5,
        "comments": "Buy side updated after reprice",
        "adjustments": [
          {
            "adjustmentType": "Adjustment",
            "description": "Waive Escrow and Impounds",
            "priceAdjustmentType": "BasePrice",
            "adjustment": 0.11
          },
          {
            "adjustmentType": "Adjustment",
            "description": "Mobile Margin",
            "priceAdjustmentType": "BaseMargin",
            "adjustment": 0.22
          },
          {
            "adjustmentType": "Adjustment",
            "description": "60 Day Lock Period",
            "priceAdjustmentType": "BaseRate",
            "adjustment": 0.33
          }
        ]
      },
      "sellSide": {
        "srp": 1.25,
        "servicing": {
          "type": "Service Retained",
          "servicer": "ABC Servicing",
          "fee": {
            "servicing": 0.25,
            "guarantyBase": 0.45,
            "guarantee": 0.45
          },
          "pool": {
            "number": "POOL-1001",
            "id": "P1001"
          },
          "commitmentContractNumber": "CC-342432",
          "productName": "30 Year Fixed",
          "msrValue": 1.1
        },
        "commitmentDate": "07/07/2020",
        "rateSheetId": "RS9110",
        "lastRateSetDate": "05/07/2020",
        "lockDate": "07/07/2020",
        "lockExpirationDate": "07/21/2020",
        "baseRate": 4.25,
        "basePrice": 100.25,
        "baseMarginRate": 2.25,
        "comments": "Sell side updated after investor commitment",
        "srpPaidOut": 1.25,
        "investor": {
          "name": "ABC Mortgage Investors",
          "contact": "Pat Lee",
          "phone": "8005550100",
          "email": "[email protected]",
          "address": "100 Main Street",
          "city": "San Diego",
          "state": "CA",
          "postalCode": "92101",
          "website": "https://www.example.com",
          "lockType": "Best Efforts",
          "programCode": "CF30",
          "commitment": "CMT-100045",
          "templateName": "Standard investor template",
          "loanNumber": "INV-778899",
          "mersNumber": "100000000000000001",
          "lockedDate": "07/07/2020",
          "deliveryDate": "07/30/2020",
          "targetDeliveryDate": "07/28/2020"
        },
        "adjustments": [
          {
            "adjustmentType": "Adjustment",
            "description": "60 Day Lock Period",
            "priceAdjustmentType": "BaseRate",
            "adjustment": 0.33
          }
        ]
      },
      "comparison": {
        "servicingType": "Service Released",
        "rateSheetId": "RS9110",
        "lastRateSetDate": "05/07/2020",
        "lockDate": "07/07/2020",
        "lockExpirationDate": "07/21/2020",
        "baseRate": 4.375,
        "basePrice": 100.0,
        "baseMarginRate": 2.25,
        "comments": "Best alternate investor pricing",
        "srpPaidOut": 1.0,
        "investor": {
          "name": "XYZ Capital Markets",
          "contact": "Pat Lee",
          "phone": "8005550100",
          "email": "[email protected]",
          "address": "100 Main Street",
          "city": "San Diego",
          "state": "CA",
          "postalCode": "92101",
          "website": "https://www.example.com",
          "lockType": "Best Efforts",
          "programCode": "CF30",
          "commitment": "CMT-100045",
          "templateName": "Standard investor template",
          "status": "Active",
          "statusDate": "07/07/2020"
        },
        "adjustments": [
          {
            "adjustmentType": "Adjustment",
            "description": "60 Day Lock Period",
            "priceAdjustmentType": "BaseRate",
            "adjustment": 0.33
          }
        ]
      },
      "additionalFields": [
        {
          "fieldName": "CX.PPE.PRICINGTIER",
          "stringValue": "Gold"
        }
      ]
    }
  },
  "partnerStatus": "partner status"
}