List Wholesale Billing Reports
Search for associated wholesale billing reconciliation reports.
GET/v1/wholesale/billing/reports
Query Parameters
billingStartDate
string
Only include billing reports having this billing startDate.
billingEndDate
string
Only include billing reports having this billing endDate.
sortBy
string
Sort the reports.
Possible values: id, billingStartDate, billingEndDate, status
Default: billingStartDate
type
string
Only include reports of this type.
Possible values: PARTNER, CUSTOMER, USER
status
string
The status of the billing report
Possible values: IN_PROGRESS, COMPLETED, FAILED
max
integer
Limit the maximum number of reports returned in the response, up to 100 per page. Refer to the Pagination section of Webex REST API Basics.
Default: 100
subPartnerOrgId
string
The Organization ID of the sub partner on Cisco Webex.
Response Properties
items
array[ListReport]
An array of report objects.
id
string
A unique report id that corresponds to a billing report.
billingStartDate
string
Billing report startDate.
billingEndDate
string
Billing report endDate.
status
enum
The status of the billing report
IN_PROGRESS
string
Report generation is in progress.
COMPLETED
string
Report generation is complete.
FAILED
string
Report generation failed.
type
enum
Billing Report Type.
USER
string
CUSTOMER
string
PARTNER
string
Response Codes
The list below describes the common success and error responses you should expect from the API:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
GET
/v1/wholesale/billing/reports{?billingStartDate,billingEndDate,type,sortBy,status,max,subPartnerOrgId}
Log in to try the API.
Header
Query Parameters
- Only include billing reports having this billing `startDate`.
- Only include billing reports having this billing `endDate`.
- Sort the reports.
- Only include reports of this type.
- The status of the billing report
- Limit the maximum number of reports returned in the response, up to 100 per page. Refer to the [Pagination](/docs/basics#pagination) section of [Webex REST API Basics](/docs/api/basics).
- The Organization ID of the sub partner on Cisco Webex.
https://webexapis.com/v1/wholesale/billing/reports?billingStartDate=2020-05-21&billingEndDate=2020-05-30&sortBy=%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D&type=%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D&status=%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D&max=10&subPartnerOrgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi81MmNmNTc2ZC02MGE4LTQwN2EtYjIyYy00NjdjNTE1OTE5MDg
200 / OK
{
"items": [
{
"id": "Y2lzY29zcGFyazovL3VzL0JJTExJTkdfUkVQT1JULzViOGQ1MThhLThmMDAtNDUxYi1hNDA2LWVhZjQ5YjRhN2ZhOA",
"billingStartDate": "2021-05-21",
"billingEndDate": "2021-05-30",
"status": "COMPLETED",
"type": "PARTNER"
},
{
"id": "Y2lzY29zcGFyazovL3VzL0JJTExJTkdfUkVQT1JULzViOGQ1MThhLThmMDAtNDUxYi1hNDA2LWVhZjQ5YjRhN2Zh2B",
"billingStartDate": "2021-05-21",
"billingEndDate": "2021-05-30",
"status": "COMPLETED",
"type": "PARTNER"
},
{
"id": "Y2lzY29zcGFyazovL3VzL0JJTExJTkdfUkVQT1JULzViOGQ1MThhLThmMDAtNDUxYi1hNDA2LWVhZjQ5YjRhN2Zh5D",
"billingStartDate": "2021-05-21",
"billingEndDate": "2021-05-30",
"status": "COMPLETED",
"type": "PARTNER"
}
]
}