Create budget

post

https://api.rocketlane.com/api/1.0/budgets

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

includeFields

array of strings

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.

includeFields

Allowed:

includeAllFields

boolean

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.

Body Params

projectId

int64

required

Unique identifier of the project this budget belongs to

budgetName

string

required

Display name of the budget

startDate

date

required

Budget period start date

endDate

date

required

Budget period end date

status

object

The value of the budget status can be specified here.

billingType

string

enum

required

Contract type or billing method for this budget.

Allowed:

revenueRecognitionType

string

Revenue recognition method for this budget. Use a standard type (e.g. TRACKED_HOURS_BY_PERIOD_HOURS, MANUAL, MILESTONE_BASED) or CUSTOM_REVENUE_RECOGNITION with customRevenueRecognitionConfigId.

customRevenueRecognitionConfigId

int64

Unique identifier of the custom revenue recognition configuration to apply. Required when revenueRecognitionType is CUSTOM_REVENUE_RECOGNITION.

budgetAmount

number

Budget amount for this budget.

budgetHours

double

Budgeted hours for this budget, expressed as a decimal with up to two decimal places. The fractional part represents minutes (e.g. 1.65 = 1 hour 39 minutes). Internally, budget time is stored as whole minutes; on write, the value is converted as hours × 60, rounded to the nearest minute.

timeAndMaterialContract

object

This section addresses the financial aspects of the Time & Material contract type projects and its associated fields.

subscriptionContract

object

This section addresses the financial aspects of the Subscription contract type projects and its associated fields.

fields

array of objects

Custom fields on this budget. The fieldValue must match the field type; see the project public API field documentation for assignment examples.

fields

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The resource was successfully created in the database.

400This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.

401You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.