GET /settlements
Retrieves a list of unpaid settlement records for the given parameters.
Roles that can access this endpoint are Users, Drivers, Carriers.
Parameters
| name |
description |
type |
default |
type |
| orderId |
order ID |
query
|
|
String
|
| invoiceNumber |
external invoice number |
query
|
|
String
|
| startDate |
starting delivery date |
query
|
|
Date
|
| endDate |
ending delivery date |
query
|
|
Date
|
| payeeId |
the ID from the payee table (ignored when user is not an LME user) |
query
|
|
String
|
Result
List
<
ReadOnlyRow
>
of type:
application/xml
application/json
a list of ReadOnlyRow objects, representing unpaid settlements and pending deductions
Additional attributes:
__other_pay the calculated total of other pay__total_pay the calculate total pay of the settlement (freight pay plus other pay)__record_type the type of record (S for settlement, D for deduction)
Try It Out
Request