Endpoints for budget resources
Budget Overview
Rocketlane's budgets help you plan and track project financials — contract type, budgeted amount and hours, revenue recognition, and related metrics — on a single project.
Budgets support Time & Material, Fixed Fee, Subscription, and Non-billable contract types. You can attach custom fields, configure revenue recognition (including custom recognition methods), and maintain manual or milestone-based recognition plans on a budget.
The Rocketlane Budgets API offers a robust and versatile solution for developers to integrate budget management into their applications, empowering teams to create, retrieve, update, search, and delete budgets efficiently.
Default Budget Fields
| Field | Description |
|---|---|
| budgetId | The budget’s unique, system-generated identifier, which can be used to identify the budget globally. |
| projectId | The unique identifier for the project this budget belongs to. This field is required when creating a budget. |
| projectName | The name of the project containing this budget. |
| budgetName | The name of the budget. This field is required when creating a budget. |
| startDate | The date on which the budget period begins. This field is required when creating a budget. The format for the start date is YYYY-MM-DD. |
| endDate | The date on which the budget period ends. This field is required when creating a budget. The format for the end date is YYYY-MM-DD. |
| status | The value of the budget status which is essential to keep track of the budget. On create or update, specify the status using its value (unique identifier). Responses also include the status label. |
| isDefault | Denotes whether this is the default budget for the project. |
| currency | The currency code used for budget amounts. |
| billingType | The financial contract type for the budget. Allowed values are FIXED_FEE, TIME_AND_MATERIAL, SUBSCRIPTION, and NON_BILLABLE. This field is required when creating a budget. |
| revenueRecognitionType | The revenue recognition method configured for the budget (for example TRACKED_HOURS_BY_PERIOD_HOURS, MANUAL, or MILESTONE_BASED). Use CUSTOM_REVENUE_RECOGNITION together with customRevenueRecognitionConfigId to attach a custom recognition config. |
| customRevenueRecognitionConfigId | The unique identifier of the custom revenue recognition configuration when revenueRecognitionType is CUSTOM_REVENUE_RECOGNITION. |
| budgetAmount | The total budgeted amount for the budget. |
| budgetHours | Budgeted hours for this budget, returned as a decimal with up to two decimal places. The fractional part represents minutes (for example 1.65 = 1 hour 39 minutes). Internally, budget time is stored as whole minutes. |
| timeAndMaterialContract | Financial aspects specific to Time & Material budgets, such as the associated rate card. |
| subscriptionContract | Financial aspects specific to Subscription budgets, such as subscription frequency, subscription start date, period minutes, period budget, and number of periods. |
| budgetFinancialsMetrics | Read-only financial metrics for this budget, including tracked, allocated, and remaining time, as well as estimated and actual revenue, cost, profit, and margins. |
| manualRevenueRecognitionConfigs | Manual revenue recognition configurations for this budget. Each entry includes a recognition date and the recognized revenue amount or percentage. Include this field in get and list responses using includeFields=manualRevenueRecognitionConfigs, or manage it via the manual revenue recognition configs endpoint. |
| milestoneRevenueRecognitionConfigs | Milestone-based revenue recognition configurations for this budget. Each entry references a milestone source (such as a task) and the recognized revenue amount or percentage. Include this field using includeFields=milestoneRevenueRecognitionConfigs, or manage it via the milestone revenue recognition configs endpoint. |
| fields | Fields lists the custom budget fields whose values were provided during budget creation or updated later. |
| createdAt | The time when the budget was created. The referenced time will be in epoch millis. |
| updatedAt | The time when the budget was updated. Any changes related to the budget are captured and specified here in epoch millis. |
| createdBy | The team member who created the budget. |
| updatedBy | The team member who last updated the budget. |