go back Home

PayeeService

This service provides methods for retrieving and updating payee records.

Operations

name role description
GET /payees Users Retrieves a List of RowPayees with a full or partial match to the given value.
GET /payees/activeMoves Users, Carriers, Carrier Drivers Retrieves a List of RowMovement objects for the current user.
GET /payees/new Users Creates a payee object with all configured defaults set. This doesn't create a record in the database. Instead, callers of this method can edit the returned object and then pass it back to the create method to actually insert the record in the database.
GET /payees/search Users Searches the database for locations matching the given request parameters.
GET /payees/userSavedSearch Users Retrieves a List of RowPayee objects based on an existing saved search.
GET /payees/{id} Users Retrieves the Payee for the payee ID
GET /payees/{id}/revenueReport Users Generates a brokerage revenue report for the specified carrier, date range, etc.
PUT /payees/create Users Creates a new RowPayee record for the given Payee data.
PUT /payees/update Users Updates a RowPayee record for the given Payee data.