GET/projects/api/v3/reporting/dashboards/details/budgets.json

Get budget chart details.

This returns a list of budgets matching a budget chart filter. Used for quick views and similar UI elements

Query Params

  • Name
    startDate
    Type
    string
    Description

    start date

  • Name
    searchTerm
    Type
    string
    Description

    filter by project name

  • Name
    orderMode
    Type
    string
    Description

    order mode

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

    order by

    Default
    name
    Allowed values
    • startdate
    • duedate
    • datecreated
    • name
  • Name
    endDate
    Type
    string
    Description

    end date

  • Name
    budgetType
    Type
    string
    Description

    filter by budget type

    Allowed values
    • all
    • financial
    • time
  • Name
    splitBy
    Type
    object
    Description

    split by entity

    Default
    none
    Allowed values
    • budget.project
    • budget.company
    • budget.type
    • budget.timelog_type
    • budget.category
    • budget.currency
    • budget.status
    • budget.usage
    • project.start_date
    • project.end_date
    • project.created_date
    • project.completed_date
  • Name
    metric
    Type
    object
    Description

    data point

  • Name
    groupBy
    Type
    object
    Description

    group by entity

    Default
    none
    Allowed values
    • budget.project
    • budget.company
    • budget.type
    • budget.timelog_type
    • budget.category
    • budget.currency
    • budget.status
    • budget.usage
    • project.start_date
    • project.end_date
    • project.created_date
    • project.completed_date
  • Name
    pageSize
    Type
    integer
    Description

    number of items in a page

    Default
    50
  • Name
    page
    Type
    integer
    Description

    page number

    Default
    1
  • Name
    skipCounts
    Type
    boolean
    Description

    SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.

  • Name
    matchAllProjectTags
    Type
    boolean
    Description

    match all project tags

  • Name
    projectTagIds
    Type
    array[integer]
    Description

    filter by project tag ids

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

    filter by project status

    Format
    Comma separated values
    Allowed values
    • active
    • current
    • late
    • upcoming
    • completed
    • deleted
  • Name
    projectOwnerIds
    Type
    array[integer]
    Description

    filter by project owner ids

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

    filter by project ids

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

    filter by project healths

    0: not set 1: bad 2: ok 3: good

    Format
    Comma separated values
    Allowed values
    • 0
    • 1
    • 2
    • 3
  • Name
    projectCompanyIds
    Type
    array[integer]
    Description

    filter by company ids

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

    filter by project category ids

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

    include

    Format
    Comma separated values
    Allowed values
    • projects.categories
    • projects.companies
    • projectOwners
  • Name
    budgetStatuses
    Type
    array[string]
    Description

    list of project budget status

    Format
    Comma separated values
    Allowed values
    • all
    • active
    • archived
    • deleted
    • invalid
    • completed
    • upcoming
  • Name
    budgetCategories
    Type
    array[string]
    Description

    filter by budget category

    Default
    all
    Format
    Comma separated values
    Allowed values
    • all
    • retainer
    • standard
    • fixedfee

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    BudgetsResponse contains information about a group of budgets.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

BudgetsResponse
{  "budgets": [    {      "baselineCapacity": 0,      "budgetCategory": "string",      "budgetExpectedCost": 0,      "budgetExpectedProfit": 0,      "budgetProfitMargin": 0,      "capacity": 0,      "capacityUsed": 0,      "carryCapacity": 0,      "carryOverspend": true,      "carryUnderspend": true,      "completedAt": "string",      "completedBy": 0,      "completedByUserId": 0,      "createdAt": "string",      "createdBy": 0,
Download Swagger