Sign in
latestOpenAPI 3.0.02026-08-12207455917.9 KB

bad0d2db9b7a

Sale Commissions

Update commissions

Updates commissions for the specified sale. Returns 422 if commissions have not been added yet, if percent and amount are both set for the same commission, if values are out of range, or if required managed fields are missing.

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.

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

Path parameters

saleGuidstring guid required

GUID of the sale whose commissions you want to update.

Request body

transactionCoordinatorNamestring nullable

Deprecated. Use the /transactionCoordinators endpoint for Transaction Coordinator names.

transactionCoordinatorFeenumber nullable

Deprecated. Use AdminBrokerageComp instead.

adminBrokerageCompnumber nullable

Admin brokerage compensation fee. Preferred over TransactionCoordinatorFee.

dateOfCheckstring date-time nullable
datePostedToLogBookstring date-time nullable
listingCommissionPercentnumber nullable

If required, either percent or amount field needs to be filled

listingCommissionAmountnumber nullable

If required, either percent or amount field needs to be filled

saleCommissionPercentnumber nullable

If required, either percent or amount field needs to be filled

saleCommissionAmountnumber nullable

If required, either percent or amount field needs to be filled

otherDeductionsnumber nullable
personalDealboolean
commissionBreakdownDetailsstring nullable

Response

valueUpdateSaleCommissionsResponse
warningsstring[] nullable