go back to PayeeService

GET /payees/{id}/revenueReport

Generates a brokerage revenue report for the specified carrier, date range, etc.

Roles that can access this endpoint are Users.

Parameters

name description type default type
id the ID of the payee/carrier path String
dateType S - Ship Date, D - Delivery Date, anything else - Bill Date query String
startDate the start of the date range for the specified date type query t Date
endDate the end of the date range for the specified date type query t Date
groupBy c - Customer, a - Carrier, d - Dispatcher, r - Revenue Code, anything else - Controlling Party query String
sortBy secondary sort; B - Bill Date, D - Delivery Date, anything else - Order number query String
reportType S - Summary, D - Detailed query String
statusDelivered whether to include delivered movements query false Boolean
statusAvailable whether to include available movements query false Boolean
statusInProgress whether to include in progress movements query false Boolean

Result

Response of type: application/pdf

a response object containing the requested brokerage revenue report in PDF format

Try It Out

Request

- Authentication Help
- String
- String
- Date
- Date
- String
- String
- String
- Boolean
- Boolean
- Boolean