latestOpenAPI 3.0.02026-08-12207455917.9 KB
bad0d2db9b7a
Sale Additional Commissions Information Log
Edit commission log entry
Updates an existing commission log entry's comment text and/or visibility. Broker, auditor, and trial broker can edit any public note; agents can only edit their own notes. Only the note creator can update the text of a private note. Only privileged roles (broker, auditor, trial broker) can change visibility.
Validation & Requirements
Required Parameters
- saleGuid (path, string, format=guid)
- commentId (path, integer, format=int32)
- form (body, object)
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}/commissionLog/{commentId}
Path parameters
saleGuidstring guid required
GUID of the sale.
commentIdinteger required
ID of the commission log entry to edit.