| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| All Verbs | /reports/billing |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportRequest(IReturn[ReportInfo], IPost):
# @ApiMember(Description="The account ID this report should be run for")
account_id: Optional[str] = None
"""
The account ID this report should be run for
"""
# @ApiMember(Description="The email address to notify after the report is run")
email_address_to_notify: Optional[str] = None
"""
The email address to notify after the report is run
"""
# @ApiMember(Description="The webhook to call after the report is complete with the data from the report")
webhook_url: Optional[str] = None
"""
The webhook to call after the report is complete with the data from the report
"""
@staticmethod
def response_type(): return ReportInfo
class ReportStatuses(str, Enum):
QUEUED = 'Queued'
RUNNING = 'Running'
COMPLETED = 'Completed'
ERROR = 'Error'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportInfo:
id: Optional[str] = None
name: Optional[str] = None
status: Optional[ReportStatuses] = None
status_message: Optional[str] = None
date_created: Optional[str] = None
date_updated: Optional[str] = None
download_link: Optional[str] = None
job_id: Optional[str] = None
email_address_to_notify: Optional[str] = None
server: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BillingReport(ReportRequest):
start_date: Optional[str] = None
end_date: Optional[str] = None
include_customer_ids: bool = False
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
Content-Length: length
{"startDate":"String","endDate":"String","includeCustomerIds":false,"accountId":"String","emailAddressToNotify":"String","webhookUrl":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"id":"String","name":"String","status":"Queued","statusMessage":"String","dateCreated":"String","dateUpdated":"String","downloadLink":"String","jobId":"String","emailAddressToNotify":"String","server":"String"}