Sale Commission Referral

Update commission referral

Patches commission-referral details for the specified sale. Set contact to null to remove the contact. Returns 422 if referral data does not exist, referral type is unknown, required referral type is missing, percent and amount are both set, values are out of range (percent 0-100; amount >= 0), brokerName exceeds 50 characters, or contact fields are invalid.

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.
  • Commission referral values must satisfy domain commission rules; invalid percentages/amounts return 422.

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}/commissionReferral

Path parameters

saleGuidstring guid required

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

Query parameters

Contact.FirstNamestring nullable
Contact.LastNamestring nullable
Contact.Emailstring nullable
Contact.PhoneNumberstring nullable
TypeIdinteger nullable
BrokerNamestring nullable
Amountnumber nullable
Percentnumber nullable

Response

warningsstring[] nullable