Sign in

v1

latestOpenAPI 3.0.32026-08-0613775357.6 KB
budget_items

Create budget item

Creates a budget item for the speicified project or phase.

post/projects/{project_id}/budget_items

Request body

idinteger

Unique identifier for the resource instance.

amountnumber nullable required

Budget item amount

assignable_idinteger

Unique identifier of the project or phase to which the budget is assigned.

assignable_parent_idinteger

If the budget is assigned to a phase, it's the unique identifier of the phase's parent project.

categorystring

Genre for the budget item.

Expense Categories are classifications of non-labor or time-related project costs. These are predefined categories, with optional organizational guidelines for per-item cost, that you can use when defining a project budget. When entering an expense, you and your team members choose which category best represents the expense. Examples of expense categories might be travel, printing, or materials.

item_type'TimeFees' | 'TimeFeesDays' | 'Expenses' required

The kind of item being budgeted.

  • "TimeFees" is for currency-based budgeting ($).
  • "TimeFeesDays" is for time-based budgeting (hours).
  • "Expenses" is for non-time-related, currency-based budgeting ($).
peritem_amountnumber

Currency-based cost for a predefined expense item.

peritem_labelstring

Name of an expense item that has a predefined cost.

created_atstring date-time

The item's creation timestamp.

updated_atstring date-time

Timestamp of the most recent modification.

Example request

{
  "id": 6789,
  "amount": 30.5,
  "assignable_id": 821065,
  "item_type": "TimeFeesDays",
  "created_at": "2025-01-22T06:00:30Z",
  "updated_at": "2025-01-22T06:13:40Z"
}

Response

The new budget item.

idinteger

Unique identifier for the resource instance.

amountnumber nullable

Budget item amount

assignable_idinteger

Unique identifier of the project or phase to which the budget is assigned.

assignable_parent_idinteger

If the budget is assigned to a phase, it's the unique identifier of the phase's parent project.

categorystring

Genre for the budget item.

Expense Categories are classifications of non-labor or time-related project costs. These are predefined categories, with optional organizational guidelines for per-item cost, that you can use when defining a project budget. When entering an expense, you and your team members choose which category best represents the expense. Examples of expense categories might be travel, printing, or materials.

item_type'TimeFees' | 'TimeFeesDays' | 'Expenses'

The kind of item being budgeted.

  • "TimeFees" is for currency-based budgeting ($).
  • "TimeFeesDays" is for time-based budgeting (hours).
  • "Expenses" is for non-time-related, currency-based budgeting ($).
peritem_amountnumber

Currency-based cost for a predefined expense item.

peritem_labelstring

Name of an expense item that has a predefined cost.

created_atstring date-time

The item's creation timestamp.

updated_atstring date-time

Timestamp of the most recent modification.

Example response

{
  "id": 6789,
  "amount": 30.5,
  "assignable_id": 821065,
  "item_type": "TimeFeesDays",
  "created_at": "2025-01-22T06:00:30Z",
  "updated_at": "2025-01-22T06:13:40Z"
}