latestOpenAPI 3.0.02026-08-12207455917.9 KB
bad0d2db9b7a
Earnest money deposit
Update earnest money deposit
Patches earnest-money-deposit fields for the specified sale. Only fields supplied in the patch are updated. Invalid patch value types return 422. DatePostedToLogBook and DateOfCheck are normalized to date-only values.
Validation & Requirements
Required Parameters
- saleGuid (path, string, format=guid)
Required JSON Body Fields
- None
Validations
- Invalid GUID values in *Guid/*Guids fields return 422 Unprocessable Entity.
- Invalid date values in *date* fields return 422 Unprocessable Entity.
- Missing required request body returns 422 Unprocessable Entity with Missing request body..
- Additional business-rule validation may return 422 with details in the errors array.
Integration Requirement
- Retrieve the corresponding ...Form endpoint immediately before write operations to get current dynamic required fields and allowed values.
patch/api/files/sales/{saleGuid}/earnestMoneyDeposit
Path parameters
saleGuidstring guid required
GUID of the sale whose earnest money deposit you want to update.
Query parameters
IsEarnestMoneyHeldboolean nullable
DepositAmountnumber nullable
DepositDueDatestring date-time nullable
DatePostedToLogBookstring date-time nullable
DateOfCheckstring date-time nullable
AdditionalDepositAmountnumber nullable
AdditionalDepositDueDatestring date-time nullable