GET/projects/api/v3/reporting/financial/totals.json

Get financial report totals.

Returns grand totals across all matching rows without pagination. groupBy is limited to at most one dimension (e.g. company or date) — the grain for averages and counts; a second dimension is rejected with a 400. Use /trends/totals for per-period summaries.

Query Params

  • Name
    startDate
    Type
    string
    Description

    start date

  • Name
    orderMode
    Type
    string
    Description

    order mode

    Default
    asc
    Allowed values
    • asc
    • desc
  • Name
    orderBy
    Type
    string
    Description

    order by field; for /trends: name, <metricKey> (full-range aggregate), or <periodIndex>-<metricKey> (0-based, chronological)

  • Name
    endDate
    Type
    string
    Description

    end date

  • Name
    dateGranularity
    Type
    string
    Description

    date granularity (only when date in groupBy)

    Allowed values
    • daily
    • weekly
    • monthly
    • quarterly
    • yearly
  • Name
    averageBy
    Type
    string
    Description

    dimension the averages are computed per; must be one of the dimensions in groupBy. Defaults to the first groupBy dimension. date => average per period.

    Allowed values
    • company
    • project
    • projectbudget
    • tasklist
    • tasklistbudget
    • task
    • user
    • jobrole
    • timelog
    • allocation
    • billablerate
    • costrate
    • date
  • Name
    pageSize
    Type
    integer
    Description

    number of items in a page

    Default
    50
  • Name
    page
    Type
    integer
    Description

    page number

    Default
    1
  • Name
    userIds
    Type
    array[integer]
    Description

    filter by user ids

    Format
    Comma separated values
  • Name
    tasklistIds
    Type
    array[integer]
    Description

    filter by tasklist ids

    Format
    Comma separated values
  • Name
    tasklistBudgetIds
    Type
    array[integer]
    Description

    filter by tasklist budget ids

    Format
    Comma separated values
  • Name
    taskIds
    Type
    array[integer]
    Description

    filter by task ids

    Format
    Comma separated values
  • Name
    projectIds
    Type
    array[integer]
    Description

    filter by project ids

    Format
    Comma separated values
  • Name
    projectBudgetIds
    Type
    array[integer]
    Description

    filter by project budget ids

    Format
    Comma separated values
  • Name
    metrics
    Type
    array[string]
    Description

    selected fact metrics to include

    Format
    Comma separated values
  • Name
    jobRoleIds
    Type
    array[integer]
    Description

    filter by job role ids (applies when grouping by jobrole)

    Format
    Comma separated values
  • Name
    include
    Type
    array[string]
    Description

    include

    Format
    Comma separated values
    Allowed values
    • companies
    • projects
    • users
    • teams
    • tasks
    • tasklists
    • projectbudgets
    • tasklistbudgets
    • timelogs
    • allocations
    • jobRoles
  • Name
    groupBy
    Type
    array[string]
    Description

    group by dimensions (ordered chain)

    Format
    Comma separated values
    Allowed values
    • company
    • project
    • projectbudget
    • tasklist
    • tasklistbudget
    • task
    • user
    • jobrole
    • timelog
    • allocation
    • billablerate
    • costrate
    • date
  • Name
    filter
    Type
    array[any]
    Description

    advanced filter (JSON)

    Format
    Comma separated values
  • Name
    companyIds
    Type
    array[integer]
    Description

    filter by company ids

    Format
    Comma separated values
  • Name
    allocationIds
    Type
    array[integer]
    Description

    filter by allocation ids

    Format
    Comma separated values

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    FinancialReportTotalsResponse is the response for the financial report totals endpoint. Sources holds per-source column totals (grand sum of each source metric across all rows). Counts holds the distinct entity count per groupBy dimension (e.g. "company", "project", "date").
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.
  • Code
    500
    Type
    object
    Schema
    Description
    500 Internal Server Error
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

FinancialReportTotalsResponse
{
  "averages": {
    "averageBy": "string",
    "sources": {
      "additionalProp": {}
    }
  },
  "counts": {
    "additionalProp": 0
  },
  "sources": {
    "additionalProp": {}
  }
}
Download Swagger