go back to CarrierDispatchService

POST /carrierDispatch/setPay/{movementId}

Sets the carrier pay for a given movement.

Roles that can access this endpoint are Users.

Parameters

name description type default type
movementId ID of the movement to update path String
overrideMaxPay decimal amount by which to override the existing max pay query BigDecimal
method pay method query String
units pay units query BigDecimal
rate per unit rate query BigDecimal
carrierPay decimal amount to set as the carrier pay query BigDecimal
overrideTargetPay decimal amount by which to override the existing max pay query BigDecimal

Result

Response of type: text/plain

a response object containing a success/failure message

Try It Out

Request

- Authentication Help
- String
- BigDecimal
- String
- BigDecimal
- BigDecimal
- BigDecimal
- BigDecimal