latestOpenAPI 3.0.02026-08-12207455917.9 KB
bad0d2db9b7a
Sale Additional Commissions Information Log
Get commission log
Gets additional commission-information log entries for the sale in timestamped order for integrator review and audit visibility. By default only public notes are returned; pass includePrivate=true to opt in to private notes (subject to role-based authorization — only broker, auditor, and trial broker will receive them).
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.
get/api/files/sales/{saleGuid}/commissionLog
Path parameters
saleGuidstring guid required
GUID of the sale whose additional commission-information log you want to retrieve.
Query parameters
includePrivateboolean
When true, includes private notes in the response for privileged roles (broker, auditor, trial broker). Defaults to false.