latestOpenAPI 3.0.02026-08-12207455917.9 KB

bad0d2db9b7a

Sale Commission Breakdowns

Update commission breakdown

Replaces commission breakdown entries for the specified sale. commissionBreakdowns must not be null. Use an empty array to clear all breakdowns. You can submit at most 5 breakdown entries, and each entry requires a name; 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.

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

Path parameters

saleGuidstring guid required

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

Request body

Response

valueUpdateSaleCommissionBreakdownResponse
warningsstring[] nullable