Get service cost summary by company

Returns one row per company: the cost of every service for the requested period plus the resulting total.

Access is enforced per caller. With onlyForMyCompany=true the response holds a single row — the company of the authenticated user — and requires the corresponding read permission on that company. Without that flag the operation returns every company the platform bills and requires platform-wide access; a caller without it receives 403.

Rows are always ordered by priceTotal descending — the order cannot be changed, and sort, fields and page are not supported here. Use limit together with offset to paginate.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Determines whether the statistic should be received only for a company of the authenticated user.

integer

Narrows the result down to a single company. Applies only when onlyForMyCompany is not set and therefore requires platform-wide access. Note the name: companyIdFilter, not companyId.

string
^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\+[0-9]{2}:[0-9]{2}$

The start date (for example, 2018-05-27T21:30:54+00:00). (For get request need encode url)

string
^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\+[0-9]{2}:[0-9]{2}$

The end date (for example, 2018-05-27T21:30:54+00:00). (For get request need encode url)

boolean

Excludes companies whose total is zero.

boolean

Groups the result by reseller and sums the reseller price instead of the company price. subscriptionFee still carries the reseller's own subscription fee, not the sum over its downline companies.

integer
Defaults to 10

Maxium number of returning records.

integer

Starting point to return records from a result set.

string
enum

Determines the output format. CSV_EXCEL format includes UTF-8 BOM and semicolon delimiter for better Excel compatibility.

Allowed:
Responses

400

Invalid input parameters

401

User is not authenticated

403

Invalid user permissions

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json