ROrocketlane
Budgets

Get all budgets

Changed on
get/1.0/budgets

Request

Query parameters

budgetId.eqstring

Filter by budget ID. Supported operators: eq, oneOf, noneOf.

budgetId.oneOfstring
Example:101,102

Filter by budget ID. Supported operators: eq, oneOf, noneOf.

budgetId.noneOfstring
Example:101,102

Filter by budget ID. Supported operators: eq, oneOf, noneOf.

projectId.eqstring

Filter by project ID the budget belongs to. Supported operators: eq, oneOf, noneOf.

projectId.oneOfstring
Example:42,43

Filter by project ID the budget belongs to. Supported operators: eq, oneOf, noneOf.

projectId.noneOfstring
Example:42,43

Filter by project ID the budget belongs to. Supported operators: eq, oneOf, noneOf.

status.eqstring

Filter by budget status ID (numeric). Supported operators: eq, gt, ge, lt, le, oneOf, noneOf.

status.oneOfstring
Example:1,2

Filter by budget status ID (numeric). Supported operators: eq, gt, ge, lt, le, oneOf, noneOf.

status.noneOfstring

Filter by budget status ID (numeric). Supported operators: eq, gt, ge, lt, le, oneOf, noneOf.

billingType.eqstring
Example:TIME_AND_MATERIAL

Filter by financial contract type (e.g. TIME_AND_MATERIAL, FIXED_FEE, SUBSCRIPTION, NON_BILLABLE). Supported operators: eq, oneOf, noneOf.

billingType.oneOfstring
Example:TIME_AND_MATERIAL,FIXED_FEE

Filter by financial contract type (e.g. TIME_AND_MATERIAL, FIXED_FEE, SUBSCRIPTION, NON_BILLABLE). Supported operators: eq, oneOf, noneOf.

billingType.noneOfstring
Example:NON_BILLABLE

Filter by financial contract type (e.g. TIME_AND_MATERIAL, FIXED_FEE, SUBSCRIPTION, NON_BILLABLE). Supported operators: eq, oneOf, noneOf.

revenueRecognitionType.eqstring
Example:TRACKED_HOURS_BY_PROJECT_HOURS

Filter by revenue recognition type. Supported operators: eq, oneOf, noneOf.

revenueRecognitionType.oneOfstring
Example:TRACKED_HOURS_BY_PROJECT_HOURS,MILESTONE_BASED

Filter by revenue recognition type. Supported operators: eq, oneOf, noneOf.

revenueRecognitionType.noneOfstring
Example:MANUAL

Filter by revenue recognition type. Supported operators: eq, oneOf, noneOf.

budgetAmount.eqstring

Filter by budget amount. Supported operators: eq, gt, ge, lt, le, oneOf, noneOf.

budgetAmount.gtstring

Filter by budget amount. Supported operators: eq, gt, ge, lt, le, oneOf, noneOf.

budgetAmount.gestring

Filter by budget amount. Supported operators: eq, gt, ge, lt, le, oneOf, noneOf.

budgetAmount.ltstring

Filter by budget amount. Supported operators: eq, gt, ge, lt, le, oneOf, noneOf.

budgetAmount.lestring

Filter by budget amount. Supported operators: eq, gt, ge, lt, le, oneOf, noneOf.

budgetHours.eqstring

Filter by budgeted hours (decimal hours; fractional part represents minutes). Supported operators: eq, gt, ge, lt, le, oneOf, noneOf.

budgetHours.gtstring

Filter by budgeted hours (decimal hours; fractional part represents minutes). Supported operators: eq, gt, ge, lt, le, oneOf, noneOf.

budgetHours.gestring

Filter by budgeted hours (decimal hours; fractional part represents minutes). Supported operators: eq, gt, ge, lt, le, oneOf, noneOf.

budgetHours.ltstring

Filter by budgeted hours (decimal hours; fractional part represents minutes). Supported operators: eq, gt, ge, lt, le, oneOf, noneOf.

budgetHours.lestring

Filter by budgeted hours (decimal hours; fractional part represents minutes). Supported operators: eq, gt, ge, lt, le, oneOf, noneOf.

budgetName.eqstring
Example:FY 2024

Filter by budget name. Supported operators: eq, cn, nc, oneOf, noneOf.

budgetName.cnstring
Example:FY

Filter by budget name. Supported operators: eq, cn, nc, oneOf, noneOf.

budgetName.ncstring
Example:Draft

Filter by budget name. Supported operators: eq, cn, nc, oneOf, noneOf.

startDate.eqstring date
Example:2023-03-28

Filter by date of issue (equals).

startDate.gtstring date
Example:2023-03-28

Filter by date of issue greater than.

startDate.gestring date
Example:2023-03-28

Filter by date of issue greater than or equal.

startDate.ltstring date
Example:2023-03-28

Filter by date of issue less than.

startDate.lestring date
Example:2023-03-28

Filter by date of issue less than or equal.

endDate.eqstring date
Example:2023-03-28

Filter by due date (equals).

endDate.gtstring date
Example:2023-03-28

Filter by due date greater than.

endDate.gestring date
Example:2023-03-28

Filter by due date greater than or equal.

endDate.ltstring date
Example:2023-03-28

Filter by due date less than.

endDate.lestring date
Example:2023-03-28

Filter by due date less than or equal.

createdAt.gtinteger
Example:1625164800000

Filter by budget created time (epoch milliseconds). Supported operators: eq, gt, ge, lt, le.

createdAt.eqinteger
Example:1625164800000

Filter by budget created time (epoch milliseconds). Supported operators: eq, gt, ge, lt, le.

createdAt.ltinteger
Example:1625164800000

Filter by budget created time (epoch milliseconds). Supported operators: eq, gt, ge, lt, le.

createdAt.geinteger
Example:1625164800000

Filter by budget created time (epoch milliseconds). Supported operators: eq, gt, ge, lt, le.

createdAt.leinteger
Example:1625164800000

Filter by budget created time (epoch milliseconds). Supported operators: eq, gt, ge, lt, le.

companyId.eqstring

You can use this param to provide a customer company id and the responses will contain exact matches of budgets that match the given customer company id.

companyId.oneOfstring
Example:1,2,3

You can use this param to provide customer company ids separated by commas and the responses will contain matches of budgets that match any of the given customer company id.

companyId.noneOfstring
Example:1,2,3

You can use this param to provide customer company id separated by commas and the responses will not contain matches of budgets that match the given set of customer company id.

isDefault.eqstring

Filter by default budget flag

pageSizenumber
Example:100

This parameter sets the maximum number of responses to be displayed per page. If the page size is insufficient to accommodate the whole number of responses obtained, the pagination object will include a link to the next page as well as the next page token. If left blank, it defaults to 100.

pageTokenstring
Example:59c12a42-dd10-11ed-afa1-0242ac120002

Use this parameter to specify the pageToken of a page to which you want to navigate. This pageToken can be obtained from a previous request which specified a limit and will only be active for 15 minutes after it is created.

includeFieldsstring[]

This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned.

includeAllFieldsboolean
Example:true

This query parameter allows you to specify if all the fields should be returned in the response body. If the field is left blank, the default properties are returned.

sortBy'createdAt' | 'budgetId' | 'projectId' | 'budgetName' | 'budgetHours' | 'budgetAmount' | 'startDate' | 'endDate'

Sort budgets by a supported field. Allowed values: createdAt, budgetId, projectId, budgetName.

sortOrder'ASC' | 'DESC'

The sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.

match'all' | 'any'

You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.

Response

The requested action was successfully executed.

Example response

{
  "data": [
    {
      "budgetId": 101,
      "projectId": 42,
      "projectName": "Acme Implementation",
      "budgetName": "FY 2024 Services",
      "startDate": "2024-01-01",
      "endDate": "2024-12-31",
      "status": {
        "value": 2,
        "label": "In progress"
      },
      "currency": "USD",
      "revenueRecognitionType": "TRACKED_HOURS_BY_PERIOD_HOURS",
      "customRevenueRecognitionConfigId": 101,
      "budgetHours": 1.65,
      "timeAndMaterialContract": {
        "rateCard": {
          "rateCardId": 21,
          "rateCardName": "US Project rate"
        }
      },
      "subscriptionContract": {
        "subscriptionFrequency": "MONTHLY",
        "subscriptionStartDate": "2023-03-28",
        "periodMinutes": 60,
        "periodBudget": 10000,
        "noOfPeriods": 10
      },
      "budgetFinancialsMetrics": {
        "actualRevenue": 10000,
        "estimatedRevenue": 200000,
        "actualRevenueInAccountCurrency": 10000,
        "estimatedRevenueInAccountCurrency": 200000,
        "actualTimeCost": 200,
        "estimatedTimeCost": 200,
        "actualTimeCostInAccountCurrency": 200,
        "estimatedTimeCostInAccountCurrency": 200,
        "actualExpenseCost": 200,
        "estimatedExpenseCost": 200,
        "actualExpenseCostInAccountCurrency": 200,
        "estimatedExpenseCostInAccountCurrency": 200,
        "actualCost": 200,
        "estimatedCost": 200,
        "actualCostInAccountCurrency": 200,
        "estimatedCostInAccountCurrency": 200,
        "trackedMinutes": 200,
        "remainingMinutes": 200,
        "allocatedMinutes": 200,
        "billableAllocatedMinutes": 200,
        "nonBillableAllocatedMinutes": 200,
        "billableTrackedMinutes": 200,
        "nonBillableTrackedMinutes": 200,
        "actualProfit": 200,
        "estimatedProfit": 200,
        "actualProfitInAccountCurrency": 200,
        "estimatedProfitInAccountCurrency": 200,
        "actualProfitMargin": 200,
        "estimatedProfitMargin": 200,
        "actualProfitMarginInAccountCurrency": 200,
        "estimatedProfitMarginInAccountCurrency": 200,
        "percentageBudgetedHoursConsumed": 200,
        "percentageBudgetConsumed": 200,
        "estimateAtCompletion": 200,
        "estimationToCompletionInHours": 200
      },
      "manualRevenueRecognitionConfigs": [
        {
          "manualRevenueRecognitionConfigId": 1001,
          "recognitionDate": "2026-04-01",
          "recognisedRevenue": 1000,
          "recognisedPercentage": 10
        }
      ],
      "milestoneRevenueRecognitionConfigs": [
        {
          "milestoneRevenueRecognitionConfigId": 1001,
          "sourceType": "TASK",
          "sourceId": 2001,
          "recognisedRevenue": 1000,
          "recognisedPercentage": 10
        }
      ],
      "createdAt": 1681319726000,
      "updatedAt": 1681319726000,
      "createdBy": {
        "emailId": "john.doe@rocketlane.com",
        "userId": 201,
        "firstName": "John",
        "lastName": "Doe"
      },
      "updatedBy": {
        "emailId": "john.doe@rocketlane.com",
        "userId": 201,
        "firstName": "John",
        "lastName": "Doe"
      },
      "fields": [
        {
          "fieldId": 201,
          "fieldLabel": "MRR",
          "fieldValueLabel": "1000"
        }
      ]
    }
  ],
  "pagination": {
    "pageSize": 100,
    "hasMore": true,
    "totalRecordCount": 250,
    "nextPage": "https://api.rocketlane.com/api/1.0/budgets?pageToken=e4a3dd8e-e338-11ed-b5ea-0242ac120002&pageSize=100",
    "nextPageToken": "e4a3dd8e-e338-11ed-b5ea-0242ac120002"
  }
}

Changes