GET /settlements/{id}
Returns the requested unpaid settlement record.
Roles that can access this endpoint are Users.
Parameters
name |
description |
type |
default |
type |
id |
the ID of the RowSettlement record |
path
|
|
String
|
Result
RowSettlement
of type:
application/xml
application/json
the requested unpaid settlement record
Additional attributes:
__payMethodDescr
This value represents the description of the pay method, found in the settlement.pay_method
field.
__payeeTypeDescr
This value represents the description of the payee type.
__commodityIdDescr
This value represents the description of the commodity, found in the settlement.commodity_id
field.
__revenueIdDescr
This value represents the description of the revenue code, found in the settlement.revenue_id
field.
Child Elements:
RowTractor
This element represent the tractor associated with the settlement.
The element contains a __name
attribute with the value tractor
.
RowTrailer
This element represent the trailer associated with the settlement.
The element contains a __name
attribute with the value trailer
.
RowDriver
This element represent the driver associated with the settlement.
The element contains a __name
attribute with the value driver
.
Try It Out
Request