GET /carrierPaymentStatus
Retrieves pending and paid settlements and deductions for a given movement id and payee id
Roles that can access this endpoint are Freight Matching.
Parameters
name |
description |
type |
default |
type |
movementId |
Movement id associated with the settlement(s) and deduction(s) to be returned |
query
|
|
String
|
payeeId |
Payee id associated with the settlement(s) and deduction(s) to be returned |
query
|
|
String
|
Result
List
<
ReadOnlyRow
>
of type:
application/xml
application/json
A list of ReadOnlyRow
containing paid and/or pending settlements and
their associated deductions
Additional settlement attributes:
order_pay
Freight charge
__total_pay
Freight charge plus deductions
deductions / pending_deductions
List of deductions / pending deductions associated with the settlement
Try It Out
Request