go back Home

SettlementService

This service provides methods for retrieving settlements (paid and unpaid), payroll history and earnings/deductions.

Operations

name role description
GET /settlements Users, Drivers, Carriers Retrieves a list of unpaid settlement records for the given parameters.
GET /settlements/history Users, Drivers, Carriers Retrieves a list of paid settlement records for the given parameters.
GET /settlements/history/search Users Searches the database for settlement history matching the given request parameters.
GET /settlements/history/{id} Users Retrieves the settlement history record for the given ID.
GET /settlements/payrollHistory Users, Drivers, Carriers Retrieves a list of payroll history records for the given parameters.
GET /settlements/payrollHistory/{id} Users Retrieves the payroll history record for the given ID.
GET /settlements/reports/paidSettlements Users, Drivers, Carriers Runs the settlement summary report for the given driver and check date range.
GET /settlements/search Users Searches the database for settlements matching the given request parameters.
GET /settlements/{id} Users Returns the requested unpaid settlement record.