Contracts - Protected

Batch Update Commissions

Changed on

Batch update all commission distributions for a contract.

Replaces all existing distributions with the provided list. Maximum 6 distributions.

Business Rules:

  • Either all absolute values must sum to total commission
  • Or all percentages must sum to 100%
put/api/contracts/{contract_id}/commissions

Request

  • Base URL
    https://api.multigest.pt (the document declares no server; this is the origin it was published from)
  • URL
    https://api.multigest.pt/api/contracts/{contract_id}/commissions
  • Auth
    API key in header x-api-token and API key in header x-origin-verify

Path parameters

contract_idinteger required

Headers

x-api-tokenstring nullable

Request body

Response

Successful Response

IDinteger required
contract_idinteger required
user_idinteger required
user_namestring nullable

Salesperson full name

valor_absolutostring required
valor_percentualstring required
calculated_valuestring nullable

Calculated commission amount

Changes

    • info

      removed the pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ from the request property ///

    • info

      removed the pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ from the request property ///

    • info

      the // response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was removed for the status

    • info

      the / response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was removed for the status

    • info

      the / response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was removed for the status