Sale Commission Splits

Update commission split

Replaces commission splits for the specified sale. commissionSplits must not be null; use an empty array to clear all splits. Each split must include an agentGuid for a co-agent on the sale, amount/percentage cannot be negative, percentage cannot exceed 100, and each split must provide either amount or percentage (not both). Invalid payloads return 422.

Validation & Requirements

Required Parameters

  • saleGuid (path, string, format=guid)
  • 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.
  • Commission percentages must be between 0 and 100, and commission amounts cannot be negative.
  • Each commission entry must be percent or amount, not both.
  • CommissionSplits cannot be null. Use an empty array to clear all commission splits.
  • Each commission split requires a non-null agentGuid.
  • commissionSplit agentGuid values must belong to existing co-agents on the sale.
  • Commission split percentages must be between 0 and 100, and amounts cannot be negative.
  • Each split must be percent or amount, not both.

Integration Requirement

  • Retrieve the corresponding ...Form endpoint immediately before write operations to get current dynamic required fields and allowed values.
put/api/files/sales/{saleGuid}/commissionSplit

Path parameters

saleGuidstring guid required

GUID of the sale whose commission split you want to update.

Request body

Response

valueUpdateSaleCommissionSplitResponse
warningsstring[] nullable