Sign in
latestOpenAPI 3.0.02026-08-12207455917.9 KB

bad0d2db9b7a

V2 Listing Commissions

Add commissions (V2)

Adds commission data to a listing using V2 managed fields. Returns 422 when commission data is already present or values fail validation.

Validation & Requirements

Required Parameters

  • listingGuid (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.
post/api/v2/files/listings/{listingGuid}/commissions

Path parameters

listingGuidstring guid required

GUID of the listing you want to add commissions to.

Request body

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

salesCommissionAmountnumber nullable

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

commissionBreakdownstring nullable
referralAmountnumber nullable
referralAmountPercentnumber nullable
transCoordinatorFeenumber nullable

Deprecated. Use AdminBrokerageComp instead.

adminBrokerageCompnumber nullable

Admin brokerage compensation fee. Preferred over TransCoordinatorFee.

officeGrossCommissionnumber nullable

Response

warningsstring[] nullable