GET api/commissions/volumeReport/{repDID}/details/{volumeTypeID}/{columnName}?bcDID={bcDID}
This method can be used to add detail to a custom generated volume report. This method will take a Rep Number, Volume Type ID, Business Center, and Volume Column Name and will return a dataset with a detailed report defining where the number shown on the volume report is aggregated from.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| repDID |
Rep Number of the Rep for which a user wishes to view volume reporting. |
string |
Required |
| volumeTypeID |
Volume Type ID to be queried. |
integer |
Required |
| columnName |
Name of the volume column that will be queried. E.g. BreakawayGV |
string |
Required |
| bcDID |
(Optional querystring parameter) ID of the business center to be reported. Inputting -1 will return results for all business centers in the same result set – same results as if you had requested them individually. If not supplied, the default BCDID 1 will be used. |
integer |
Default value is 1 |
Body Parameters
None.
Response Information
Resource Description
Collection of IRepVolumeReportDetails| Name | Description | Type | Additional information |
|---|---|---|---|
| BCDID | integer |
None. |
|
| Level | string |
None. |
|
| RepDID | string |
None. |
|
| RepName | string |
None. |
|
| Rank | string |
None. |
|
| CustomerDID | string |
None. |
|
| CustomerName | string |
None. |
|
| OrderID | integer |
None. |
|
| OrderDate | string |
None. |
|
| OrderAmount | decimal number |
None. |
|
| Volume | decimal number |
None. |
Response Formats
application/xml, text/xml, application/json, text/json
Sample not available.