GET/projects/api/v3/reporting/financial/data.xlsx

Export financial report data in XLSX format.

Downloads the financial report data as "Financial Report.xlsx": one row per groupBy level tuple, nested under its parent levels, with one column per requested metric. page/pageSize are ignored; groupBy=currency is rejected with a 400.

Query Params

  • Name
    startDate
    Type
    string
    Description

    start date

  • Name
    searchTerm
    Type
    string
    Description

    filter by matching term against the display names of the requested groupBy dimensions

  • Name
    reportFormat
    Type
    string
    Description

    format of the report export; page/pageSize are ignored on exports

    Allowed values
    • csv
    • xlsx
  • 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
    • projecttype
    • projectbudget
    • tasklist
    • tasklistbudget
    • task
    • user
    • jobrole
    • timelog
    • allocation
    • expense
    • billablerate
    • costrate
    • date
    • currency
    • team
  • Name
    pageSize
    Type
    integer
    Description

    number of items in a page

    Default
    50
  • Name
    page
    Type
    integer
    Description

    page number

    Default
    1
  • Name
    showEmptyRows
    Type
    boolean
    Description

    disables the empty-group filter and adds a row for every live entity of the groupBy grain with no fact activity in range, filters/ACL permitting

    Default
    false
  • Name
    isReportDownload
    Type
    boolean
    Description

    generate a report export; also set by requesting the endpoint with a file extension (e.g. data.csv) instead of .json

    Default
    false
  • Name
    forceRefresh
    Type
    boolean
    Description

    bypasses the cache freshness probe and forces re-population (debounced server-side)

  • Name
    userIds
    Type
    array[integer]
    Description

    filter by user ids

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

    filter by team ids (members' rows; project teams match only their own project)

    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
    • expenses
    • files
    • expenseCategories
    • milestones
    • taskliststats
    • currencies
  • Name
    groupBy
    Type
    array[string]
    Description

    group by dimensions (ordered chain)

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

    advanced filter (JSON)

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

    filter by expense ids

    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
    Description
    200 OK No Data
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.
  • Code
    403
    Type
    object
    Schema
    Description
    403 Forbidden
    ErrorResponse defines how []Error should be marshaled to JSON.
  • Code
    409
    Type
    object
    Schema
    Description
    409 Conflict
    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

400 Bad Request

ErrorResponse
{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "id": "string",
      "meta": {},
      "title": "string"
    }
  ]
}
Download Swagger