GET /customers/{id}/revenueReport
Produces a customer revenue report.
Roles that can access this endpoint are Users.
Parameters
| name |
description |
type |
default |
type |
| id |
customer ID for which to run the report |
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
|
| reportType |
S - Summary, D - Detailed |
query
|
|
String
|
| byBridgeAcct |
whether amounts will be rolled up by bridge accounts |
query
|
false |
Boolean
|
| includeFuelInRev |
whether fuel surcharges are part of revenue |
query
|
false |
Boolean
|
| includeOtherInRev |
whether non-fuel other charges are part of revenue |
query
|
false |
Boolean
|
| groupBy |
|
query
|
false |
Boolean
|
Result
Response
of type:
application/pdf
a response object containing the requested revenue report in PDF format
Try It Out
Request