go back Home

SettlementService

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

Operations

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