Requires any of the roles: | SystemAdministrator, Manager, Customer |
All Verbs | /reports/billing |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
StartDate | query | string | No | |
EndDate | query | string | No | |
IncludeCustomerIds | query | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AccountId | form | string | No | The account ID this report should be run for |
EmailAddressToNotify | form | string | No | The email address to notify after the report is run |
WebhookUrl | form | string | No | The webhook to call after the report is complete with the data from the report |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No | |
Status | form | ReportStatuses | No | |
StatusMessage | form | string | No | |
DateCreated | form | string | No | |
DateUpdated | form | string | No | |
DownloadLink | form | string | No | |
JobId | form | string | No | |
EmailAddressToNotify | form | string | No | |
Server | form | string | No |
Queued | |
Running | |
Completed | |
Error |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /reports/billing HTTP/1.1
Host: team.evovoice.io
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
startDate: String,
endDate: String,
includeCustomerIds: False,
accountId: String,
emailAddressToNotify: String,
webhookUrl: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { id: String, name: String, status: Queued, statusMessage: String, dateCreated: String, dateUpdated: String, downloadLink: String, jobId: String, emailAddressToNotify: String, server: String }