Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Financial Management

Budget

17 endpoints17 implementedAll modules →
  1. POST /rest/v1.0/budget_line_itemsCreate Budget Line Item
  2. GET /rest/v1.0/budget_line_items/{id}Show Budget Line Item
  3. PATCH /rest/v1.0/budget_line_items/{id}Update Budget Line Item
  4. GET /rest/v1.0/budget_view_snapshotsList Budget View Snapshots
  5. POST /rest/v1.0/budget_view_snapshotsCreate Budget View Snapshot
  6. GET /rest/v1.0/budget_view_snapshots/{budget_view_snapshot_id}Show Budget View Snapshot
  7. GET /rest/v1.0/budget_view_snapshots/{budget_view_snapshot_id}/varianceBudget Snapshot Variance Report
  8. GET /rest/v1.0/budget_viewsList Budget Views
  9. GET /rest/v1.0/budget_views/{budget_view_id}/summary_rowsList Budget View Summary Rows
  10. GET /rest/v1.0/projects/{project_id}/budget_modificationsList Budget Modifications
  11. POST /rest/v1.0/projects/{project_id}/budget_modificationsCreate Budget Modification
  12. GET /rest/v1.0/projects/{project_id}/budget_modifications/{id}Show Budget Modification
  13. PATCH /rest/v1.0/projects/{project_id}/budget_modifications/{id}Update Budget Modification
  14. DELETE /rest/v1.0/projects/{project_id}/budget_modifications/{id}Delete Budget Modification
  15. GET /rest/v2.0/companies/{company_id}/budget_views/{budget_view_id}Get a Budget View
  16. GET /rest/v2.0/companies/{company_id}/projects/{project_id}/budget_line_itemsList Budget Line Items
  17. DELETE /rest/v2.0/companies/{company_id}/projects/{project_id}/budget_line_items/{id}Delete Budget Line Item
POST /rest/v1.0/budget_line_items

Create Budget Line Item

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired

Request body

  • project_id
    integerrequired
  • budget_line_item
    objectrequired

Response · 201 · object

  • id
    integer
  • original_budget_amount
    number (float)
  • uom
    string
  • quantity
    number (float)
  • unit_cost
    number (float)
  • calculation_strategy
    string
  • approved_budget_changes
    number (float)
  • revised_budget
    number (float)
  • pending_budget_changes
    number (float)
  • projected_budget
    number (float)
  • committed_costs
    number (float)
  • direct_costs
    number (float)
  • pending_cost_changes
    number (float)
  • projected_costs
    number (float)
  • budget_modifications
    number (float)
  • budget_forecast
    number (float)
  • estimated_cost_at_completion
    number (float)
  • projected_over_under
    number (float)
  • cost_code
    object
  • division
    object
  • line_item_type
    object
  • currency_configuration
    object
GET /rest/v1.0/budget_line_items/{id}

Show Budget Line Item

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • project_id
    integerqueryrequired

Response · 200 · object

  • id
    integer
  • original_budget_amount
    number (float)
  • uom
    string
  • quantity
    number (float)
  • unit_cost
    number (float)
  • calculation_strategy
    string
  • approved_budget_changes
    number (float)
  • revised_budget
    number (float)
  • pending_budget_changes
    number (float)
  • projected_budget
    number (float)
  • committed_costs
    number (float)
  • direct_costs
    number (float)
  • pending_cost_changes
    number (float)
  • projected_costs
    number (float)
  • budget_modifications
    number (float)
  • budget_forecast
    number (float)
  • estimated_cost_at_completion
    number (float)
  • projected_over_under
    number (float)
  • cost_code
    object
  • division
    object
  • line_item_type
    object
  • currency_configuration
    object
PATCH /rest/v1.0/budget_line_items/{id}

Update Budget Line Item

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired

Request body

  • project_id
    integerrequired
  • budget_line_item
    objectrequired

Response · 200 · object

  • id
    integer
  • original_budget_amount
    number (float)
  • uom
    string
  • quantity
    number (float)
  • unit_cost
    number (float)
  • calculation_strategy
    string
  • approved_budget_changes
    number (float)
  • revised_budget
    number (float)
  • pending_budget_changes
    number (float)
  • projected_budget
    number (float)
  • committed_costs
    number (float)
  • direct_costs
    number (float)
  • pending_cost_changes
    number (float)
  • projected_costs
    number (float)
  • budget_modifications
    number (float)
  • budget_forecast
    number (float)
  • estimated_cost_at_completion
    number (float)
  • projected_over_under
    number (float)
  • cost_code
    object
  • division
    object
  • line_item_type
    object
  • currency_configuration
    object
GET /rest/v1.0/budget_view_snapshots

List Budget View Snapshots

v1.0Implemented

Parameters

  • project_id
    integerqueryrequired

Response · 200 · object[]

  • id
    integerrequired
  • name
    stringrequired
  • snapshot_type
    string
  • created_at
    stringrequired
  • created_by
    object
  • links
    objectrequired
POST /rest/v1.0/budget_view_snapshots

Create Budget View Snapshot

v1.0Implemented

Request body

  • project_id
    integerrequired
  • budget_view_id
    integer
  • name
    stringrequired

Response · 201 · object

  • id
    integerrequired
  • name
    stringrequired
  • snapshot_type
    string
  • created_at
    stringrequired
  • created_by
    object
  • links
    objectrequired
GET /rest/v1.0/budget_view_snapshots/{budget_view_snapshot_id}

Show Budget View Snapshot

v1.0Implemented

Parameters

  • budget_view_snapshot_id
    integerpathrequired
  • project_id
    integerqueryrequired

Response · 200 · object

  • id
    integerrequired
  • name
    stringrequired
  • snapshot_type
    string
  • created_at
    stringrequired
  • created_by
    object
  • links
    objectrequired
GET /rest/v1.0/budget_view_snapshots/{budget_view_snapshot_id}/variance

Budget Snapshot Variance Report

v1.0Implemented

Parameters

  • budget_view_snapshot_id
    integerpathrequired
  • project_id
    integerqueryrequired

Response · 200 · object

  • snapshot
    objectrequired
  • lines
    object[]required
  • totals
    objectrequired
  • currency_configuration
    object
GET /rest/v1.0/budget_views

List Budget Views

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerquery
  • page
    integerquery
  • per_page
    integerquery
  • sort
    stringquery

Response · 200 · object[]

  • id
    integer
  • name
    string
  • created_at
    string
  • created_by
    object
  • updated_at
    string
  • role
    string
  • links
    object
GET /rest/v1.0/budget_views/{budget_view_id}/summary_rows

List Budget View Summary Rows

v1.0ImplementedDeprecated: use the Analytics API

Parameters

  • OS-Company-Id
    integerheaderrequired
  • budget_view_id
    integerpathrequired
  • project_id
    integerqueryrequired
  • page
    integerquery
  • per_page
    integerquery
  • biller[]
    string[]query
  • cost_code_id[]
    integer[]query
  • cost_code_name[]
    string[]query
  • root_cost_code_id[]
    integer[]query
  • root_cost_code_name[]
    string[]query
  • category_id[]
    integer[]query
  • budget_line_item_id[]
    integer[]query
  • group_by
    stringquery
  • budget_row_type
    stringquery

Response · 200 · object[]

  • id
    string
  • name
    string
  • biller_type
    string
  • original_budget_amount
    string (float)
  • budget_modifications
    string (float)
  • budget_forecast
    object
  • currency_configuration
    object
GET /rest/v1.0/projects/{project_id}/budget_modifications

List Budget Modifications

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object[]

  • id
    integer
  • created_at
    string (date-time)
  • from_budget_line_item_id
    integer
  • notes
    string
  • origin_data
    string
  • origin_id
    string
  • to_budget_line_item_id
    integer
  • transfer_amount
    string (float)
  • updated_at
    string (date-time)
POST /rest/v1.0/projects/{project_id}/budget_modifications

Create Budget Modification

v1.0ImplementedDeprecated: use the Analytics API

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Request body

  • budget_modification
    objectrequired

Response · 201 · object

  • id
    integer
  • created_at
    string (date-time)
  • from_budget_line_item_id
    integer
  • notes
    string
  • origin_data
    string
  • origin_id
    string
  • to_budget_line_item_id
    integer
  • transfer_amount
    string (float)
  • updated_at
    string (date-time)
GET /rest/v1.0/projects/{project_id}/budget_modifications/{id}

Show Budget Modification

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · object

  • id
    integer
  • created_at
    string (date-time)
  • from_budget_line_item_id
    integer
  • notes
    string
  • origin_data
    string
  • origin_id
    string
  • to_budget_line_item_id
    integer
  • transfer_amount
    string (float)
  • updated_at
    string (date-time)
PATCH /rest/v1.0/projects/{project_id}/budget_modifications/{id}

Update Budget Modification

v1.0ImplementedDeprecated: use the Analytics API

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • budget_modification
    objectrequired

Response · 200 · object

  • id
    integer
  • created_at
    string (date-time)
  • from_budget_line_item_id
    integer
  • notes
    string
  • origin_data
    string
  • origin_id
    string
  • to_budget_line_item_id
    integer
  • transfer_amount
    string (float)
  • updated_at
    string (date-time)
DELETE /rest/v1.0/projects/{project_id}/budget_modifications/{id}

Delete Budget Modification

v1.0ImplementedDeprecated: use the Analytics API

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200

No response body.

GET /rest/v2.0/companies/{company_id}/budget_views/{budget_view_id}

Get a Budget View

v2.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • budget_view_id
    stringpathrequired
  • source_snapshot_id
    stringquery
  • project_id
    stringquery

Response · 200 · object

  • data
    object
GET /rest/v2.0/companies/{company_id}/projects/{project_id}/budget_line_items

List Budget Line Items

v2.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[wbs_code_id]
    string[]query

Response · 200 · object

  • data
    object[]
DELETE /rest/v2.0/companies/{company_id}/projects/{project_id}/budget_line_items/{id}

Delete Budget Line Item

v2.0Implemented

Parameters

  • company_id
    stringpathrequired
  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 204

No response body.

Ask the OS

Reading this page

Ask anything about this page. Answers use what you're reading as context.

Suggested

    AI · may be imperfect · sample data where shown

    Open file