GET/projects/api/v3/reporting/precanned/budget/report.json

Get budget report

Query Params

  • Name
    startDate
    Type
    string
    Description
  • Name
    searchTerm
    Type
    string
    Description

    filter by project or company

  • Name
    reportFormat
    Type
    string
    Description

    define the format of the report

    Allowed values
    • csv
  • Name
    orderMode
    Type
    string
    Description

    order mode

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

    order by

    Default
    name
    Allowed values
    • name
    • budgetStatus
    • budgetAmountFinancial
    • budgetAmountTime
    • budgetUsedFinancial
    • budgetUsedTime
    • budgetUsedPercentage
    • budgetRemainingFinancial
    • budgetRemainingTime
    • billableTime
    • nonBillableTime
    • profit
    • profitPercentage
    • billableTotal
    • revenueTimeBased
    • revenueExpenses
    • totalCost
    • costTimeBased
    • costBillableTimeBased
    • costNonBillableTimeBased
    • costExpenses
  • Name
    endDate
    Type
    string
    Description

    budget end date

  • Name
    pageSize
    Type
    integer
    Description

    number of items in a page

    Default
    50
  • Name
    page
    Type
    integer
    Description

    page number

    Default
    1
  • Name
    isReportDownload
    Type
    boolean
    Description

    generate a report export.

    Default
    false
  • Name
    expandAllProjects
    Type
    boolean
    Description

    allow to expand all projects rows

  • Name
    expandAllProjectBudgets
    Type
    boolean
    Description

    allow to expand all project budget rows

  • Name
    expandAllCompanies
    Type
    boolean
    Description

    allow to expand all companies rows

  • Name
    selectedColumns
    Type
    array[string]
    Description

    customise the report by selecting columns to be displayed

    Format
    Comma separated values
    Allowed values
    • name
    • budgetStatus
    • budgetAmountFinancial
    • budgetAmountTime
    • budgetUsedFinancial
    • budgetUsedTime
    • budgetUsedPercentage
    • budgetRemainingFinancial
    • budgetRemainingTime
    • billableTime
    • nonBillableTime
    • profit
    • profitPercentage
    • billableTotal
    • revenueTimeBased
    • revenueExpenses
    • totalCost
    • costTimeBased
    • costBillableTimeBased
    • costNonBillableTimeBased
    • costExpenses
  • Name
    include
    Type
    array[string]
    Description

    include

    Format
    Comma separated values
    Allowed values
    • companies
    • projects
    • projects.budgets
    • tasklists.budgets
    • project.tasklists
    • tasklists
    • taskliststats
  • Name
    filter
    Type
    array[any]
    Description

    filter object body

    Format
    Comma separated values
  • Name
    fields[projects]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
  • Name
    fields[projectBudgets]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • projectId
    • type
    • status
    • capacityUsed
    • capacity
    • originatorBudgetId
    • isRepeating
    • repeatPeriod
    • repeatUnit
    • repeatsRemaining
    • sequenceNumber
    • startDateTime
    • endDateTime
    • currencyCode
    • timelogType
    • expenseType
    • defaultRate
    • notificationIds
    • createdByUserId
    • dateCreated
    • updatedUserId
    • dateUpdated
    • completedByUserId
    • dateCompleted
    • deletedByUserId
    • dateDeleted
  • Name
    fields[companies]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • logoUploadedToServer
    • logoImage
  • Name
    expandedProjectIds
    Type
    array[integer]
    Description

    expand given project rows

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

    expand given project budget rows

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

    expand given company rows

    Format
    Comma separated values

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    Response 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.
  • Code
    403
    Type
    object
    Schema
    Description
    403 Forbidden
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

Response
{  "companies": [    {      "billableTime": 0,      "billableTotal": 0,      "budgetAmountFinancial": 0,      "budgetAmountTime": 0,      "budgetRemainingFinancial": 0,      "budgetRemainingTime": 0,      "budgetStatus": "string",      "budgetUsedFinancial": 0,      "budgetUsedPercentage": 0,      "budgetUsedTime": 0,      "childRowsCount": 0,      "company": {        "id": 0,        "meta": {},        "type": "string"
Download Swagger