API Docs / Operations / Reports / Get Cost & Profit Report

Get Cost & Profit Report

GET /tenants/{tenant}/reports/cost-profit

What tracked time cost the practice over the window, what the billable portion is worth, and the profit between the two, grouped by team member or client. Cost counts all time (billable or not) at the stamped cost rates; billable value counts billable time at the stamped charge-out rates, whether billed yet or not. Requires time tracking to be in use and the Cost Rates permission.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

offset query integer (int32)

Number of records to skip (default: 0). Use with limit for pagination.

Number of records to skip (default: 0). Use with limit for pagination.

limit query integer (int32)

Maximum number of records to return (default: 10, max: 50)

Maximum number of records to return (default: 10, max: 50)

dateRange query string

Preset date range for the time entry window (default Last30Days). If CustomDateRange, startDate and endDate are required.

Preset date range for the time entry window (default Last30Days). If CustomDateRange, startDate and endDate are required.

startDate query string

Entry window start (inclusive). Only valid when dateRange=CustomDateRange

Entry window start (inclusive). Only valid when dateRange=CustomDateRange

endDate query string

Entry window end (inclusive). Only valid when dateRange=CustomDateRange

Entry window end (inclusive). Only valid when dateRange=CustomDateRange

groupBy query string

Breakdown dimension: User (default) or Client

Breakdown dimension: User (default) or Client

teamCode query string

Limit the entries to those logged by the members of one team

Limit the entries to those logged by the members of one team

Responses

400 Bad Request
401 Unauthorized – Invalid or missing API key
403 Forbidden