This request allows you to add or edit an escrow adjustment.
General
This request allows you to add, edit, or even delete an escrow adjustment. Here's what you need to know about this request:
- The
EscrowAdjustments
object holds escrow adjustment information, and it's nested within theLoans
entity. - An escrow adjustment consists of two pieces of data:
- The payment period when the escrow amount will start to be added to payments
- The amount that will come due with each payment
- When you enter an escrow adjustment, it will affect all payments from the payment period you enter forward.
And for an example of how escrow adjustments work within the UI, take a look at our Create a New Escrow Adjustment article.
Database
For information on escrow database tables, see the following articles:
- Database – Escrow Adjustment Entity (escrow_adjustment_entity)
- Database – Escrow Subset Entity (escrow_subset_entity)
{
"EscrowAdjustments": {
"results": [
{
"date": "2022-09-19",
"amount": "94.83",
"subset": 2,
"period": 23
}
]
}
}
{
"EscrowAdjustments": {
"results": [
{
"date": "2021-01-01",
"amount": "100.29",
"subset": 4,
"period": 1,
"__id": 543,
"__update": true
}
]
}
}
{
"EscrowAdjustments": {
"results": [
{
"__id": 543,
"__destroy": true
}
]
}
}
Try It Instructions
Our requests often provide sample payload information so that you can receive a 200 response from simply hitting the Try It button. This request is ready for you—expand the object by clicking the "+" symbol and hit Try It to send the request.
If you would like to try this request with your own tenant account, make sure to change the headers to match your own authentication information.