Esc

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

Work Breakdown Structure

27 endpoints27 implementedAll modules →
  1. GET /rest/v1.0/companies/{company_id}/work_breakdown_structure/patternsShow the company WBS pattern
  2. GET /rest/v1.0/companies/{company_id}/work_breakdown_structure/segmentsList company WBS segments
  3. POST /rest/v1.0/companies/{company_id}/work_breakdown_structure/segmentsCreate a company WBS segment
  4. GET /rest/v1.0/companies/{company_id}/work_breakdown_structure/segments/{id}Show a company WBS segment
  5. PATCH /rest/v1.0/companies/{company_id}/work_breakdown_structure/segments/{id}Update a company WBS segment
  6. GET /rest/v1.0/companies/{company_id}/work_breakdown_structure/segments/{id}/segment_itemsList company segment items
  7. POST /rest/v1.0/companies/{company_id}/work_breakdown_structure/segments/{id}/segment_itemsCreate a company segment item
  8. GET /rest/v1.0/line_item_typesList cost types (line item types)
  9. POST /rest/v1.0/line_item_typesCreate a cost type
  10. GET /rest/v1.0/line_item_types/{id}Show a cost type
  11. PATCH /rest/v1.0/line_item_types/{id}Update a cost type
  12. GET /rest/v1.0/projects/{project_id}/work_breakdown_structure/patternsShow the project WBS pattern
  13. GET /rest/v1.0/projects/{project_id}/work_breakdown_structure/segmentsList project WBS segments
  14. POST /rest/v1.0/projects/{project_id}/work_breakdown_structure/segmentsCreate a project WBS segment
  15. GET /rest/v1.0/projects/{project_id}/work_breakdown_structure/segments/{id}Show a project WBS segment
  16. PATCH /rest/v1.0/projects/{project_id}/work_breakdown_structure/segments/{id}Update a project WBS segment
  17. GET /rest/v1.0/projects/{project_id}/work_breakdown_structure/segments/{id}/segment_itemsList project segment items
  18. POST /rest/v1.0/projects/{project_id}/work_breakdown_structure/segments/{id}/segment_itemsCreate a project segment item
  19. PATCH /rest/v1.0/projects/{project_id}/work_breakdown_structure/segments/{id}/segment_items/{item_id}Update a project segment item
  20. GET /rest/v1.0/projects/{project_id}/work_breakdown_structure/wbs_codesList assembled WBS codes
  21. POST /rest/v1.0/projects/{project_id}/work_breakdown_structure/wbs_codesCreate an assembled WBS code
  22. GET /rest/v1.0/projects/{project_id}/work_breakdown_structure/wbs_codes/{id}Show an assembled WBS code
  23. PATCH /rest/v1.0/projects/{project_id}/work_breakdown_structure/wbs_codes/{id}Update an assembled WBS code
  24. GET /rest/v1.0/standard_cost_codesList standard cost codes
  25. POST /rest/v1.0/standard_cost_codesCreate a standard cost code
  26. GET /rest/v1.0/standard_cost_codes/{id}Show a standard cost code
  27. PATCH /rest/v1.0/standard_cost_codes/{id}Update a standard cost code
GET /rest/v1.0/companies/{company_id}/work_breakdown_structure/patterns

Show the company WBS pattern

v1.0Implemented

Parameters

  • company_id
    stringpathrequired

Response · 200 · WbsPattern

  • id
    integerrequired
  • is_project_level_ordered
    booleanrequired
  • segments
    Segment[]required
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
GET /rest/v1.0/companies/{company_id}/work_breakdown_structure/segments

List company WBS segments

v1.0Implemented

Parameters

  • company_id
    stringpathrequired

Response · 200 · Segment[]

  • id
    integerrequired
  • type
    stringrequired
  • name
    stringrequired
  • position
    integerrequired
  • segment_items_count
    integer
  • required
    boolean
  • delimiter
    stringrequired
  • project_can_modify_origin_project
    boolean
  • project_can_delete_origin_company
    boolean
  • is_included_in_project_pattern
    boolean
  • structure
    stringrequired
  • tiered
    boolean
  • selectable_tiers
    boolean
  • tier_depth
    integer
  • wbs_pattern_id
    integer
  • company_id
    integer
  • project_id
    integer
  • translated_type
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
POST /rest/v1.0/companies/{company_id}/work_breakdown_structure/segments

Create a company WBS segment

v1.0Implemented

Parameters

  • company_id
    stringpathrequired

Response · 201 · Segment

  • id
    integerrequired
  • type
    stringrequired
  • name
    stringrequired
  • position
    integerrequired
  • segment_items_count
    integer
  • required
    boolean
  • delimiter
    stringrequired
  • project_can_modify_origin_project
    boolean
  • project_can_delete_origin_company
    boolean
  • is_included_in_project_pattern
    boolean
  • structure
    stringrequired
  • tiered
    boolean
  • selectable_tiers
    boolean
  • tier_depth
    integer
  • wbs_pattern_id
    integer
  • company_id
    integer
  • project_id
    integer
  • translated_type
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
GET /rest/v1.0/companies/{company_id}/work_breakdown_structure/segments/{id}

Show a company WBS segment

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · Segment

  • id
    integerrequired
  • type
    stringrequired
  • name
    stringrequired
  • position
    integerrequired
  • segment_items_count
    integer
  • required
    boolean
  • delimiter
    stringrequired
  • project_can_modify_origin_project
    boolean
  • project_can_delete_origin_company
    boolean
  • is_included_in_project_pattern
    boolean
  • structure
    stringrequired
  • tiered
    boolean
  • selectable_tiers
    boolean
  • tier_depth
    integer
  • wbs_pattern_id
    integer
  • company_id
    integer
  • project_id
    integer
  • translated_type
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
PATCH /rest/v1.0/companies/{company_id}/work_breakdown_structure/segments/{id}

Update a company WBS segment

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · Segment

  • id
    integerrequired
  • type
    stringrequired
  • name
    stringrequired
  • position
    integerrequired
  • segment_items_count
    integer
  • required
    boolean
  • delimiter
    stringrequired
  • project_can_modify_origin_project
    boolean
  • project_can_delete_origin_company
    boolean
  • is_included_in_project_pattern
    boolean
  • structure
    stringrequired
  • tiered
    boolean
  • selectable_tiers
    boolean
  • tier_depth
    integer
  • wbs_pattern_id
    integer
  • company_id
    integer
  • project_id
    integer
  • translated_type
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
GET /rest/v1.0/companies/{company_id}/work_breakdown_structure/segments/{id}/segment_items

List company segment items

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · SegmentItem[]

  • id
    integerrequired
  • code
    stringrequired
  • name
    stringrequired
  • parent_id
    integer
  • status
    stringrequired
  • is_parent
    boolean
  • in_use
    boolean
  • path_ids
    integer[]
  • path_code
    string
  • path_codes
    string[]
  • path_names
    string[]
  • segment
    SegmentStub
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
POST /rest/v1.0/companies/{company_id}/work_breakdown_structure/segments/{id}/segment_items

Create a company segment item

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Response · 201 · SegmentItem

  • id
    integerrequired
  • code
    stringrequired
  • name
    stringrequired
  • parent_id
    integer
  • status
    stringrequired
  • is_parent
    boolean
  • in_use
    boolean
  • path_ids
    integer[]
  • path_code
    string
  • path_codes
    string[]
  • path_names
    string[]
  • segment
    SegmentStub
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
GET /rest/v1.0/line_item_types

List cost types (line item types)

v1.0Implemented

Response · 200 · CostType[]

  • id
    integerrequired
  • name
    stringrequired
  • code
    stringrequired
  • base_type
    stringrequired
  • translated_base_type
    string
  • position
    integer
  • origin_data
    string
  • origin_id
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
POST /rest/v1.0/line_item_types

Create a cost type

v1.0Implemented

Response · 201 · CostType

  • id
    integerrequired
  • name
    stringrequired
  • code
    stringrequired
  • base_type
    stringrequired
  • translated_base_type
    string
  • position
    integer
  • origin_data
    string
  • origin_id
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
GET /rest/v1.0/line_item_types/{id}

Show a cost type

v1.0Implemented

Parameters

  • id
    stringpathrequired

Response · 200 · CostType

  • id
    integerrequired
  • name
    stringrequired
  • code
    stringrequired
  • base_type
    stringrequired
  • translated_base_type
    string
  • position
    integer
  • origin_data
    string
  • origin_id
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
PATCH /rest/v1.0/line_item_types/{id}

Update a cost type

v1.0Implemented

Parameters

  • id
    stringpathrequired

Response · 200 · CostType

  • id
    integerrequired
  • name
    stringrequired
  • code
    stringrequired
  • base_type
    stringrequired
  • translated_base_type
    string
  • position
    integer
  • origin_data
    string
  • origin_id
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
GET /rest/v1.0/projects/{project_id}/work_breakdown_structure/patterns

Show the project WBS pattern

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · WbsPattern

  • id
    integerrequired
  • is_project_level_ordered
    booleanrequired
  • segments
    Segment[]required
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
GET /rest/v1.0/projects/{project_id}/work_breakdown_structure/segments

List project WBS segments

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · Segment[]

  • id
    integerrequired
  • type
    stringrequired
  • name
    stringrequired
  • position
    integerrequired
  • segment_items_count
    integer
  • required
    boolean
  • delimiter
    stringrequired
  • project_can_modify_origin_project
    boolean
  • project_can_delete_origin_company
    boolean
  • is_included_in_project_pattern
    boolean
  • structure
    stringrequired
  • tiered
    boolean
  • selectable_tiers
    boolean
  • tier_depth
    integer
  • wbs_pattern_id
    integer
  • company_id
    integer
  • project_id
    integer
  • translated_type
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
POST /rest/v1.0/projects/{project_id}/work_breakdown_structure/segments

Create a project WBS segment

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 201 · Segment

  • id
    integerrequired
  • type
    stringrequired
  • name
    stringrequired
  • position
    integerrequired
  • segment_items_count
    integer
  • required
    boolean
  • delimiter
    stringrequired
  • project_can_modify_origin_project
    boolean
  • project_can_delete_origin_company
    boolean
  • is_included_in_project_pattern
    boolean
  • structure
    stringrequired
  • tiered
    boolean
  • selectable_tiers
    boolean
  • tier_depth
    integer
  • wbs_pattern_id
    integer
  • company_id
    integer
  • project_id
    integer
  • translated_type
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
GET /rest/v1.0/projects/{project_id}/work_breakdown_structure/segments/{id}

Show a project WBS segment

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · Segment

  • id
    integerrequired
  • type
    stringrequired
  • name
    stringrequired
  • position
    integerrequired
  • segment_items_count
    integer
  • required
    boolean
  • delimiter
    stringrequired
  • project_can_modify_origin_project
    boolean
  • project_can_delete_origin_company
    boolean
  • is_included_in_project_pattern
    boolean
  • structure
    stringrequired
  • tiered
    boolean
  • selectable_tiers
    boolean
  • tier_depth
    integer
  • wbs_pattern_id
    integer
  • company_id
    integer
  • project_id
    integer
  • translated_type
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
PATCH /rest/v1.0/projects/{project_id}/work_breakdown_structure/segments/{id}

Update a project WBS segment

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · Segment

  • id
    integerrequired
  • type
    stringrequired
  • name
    stringrequired
  • position
    integerrequired
  • segment_items_count
    integer
  • required
    boolean
  • delimiter
    stringrequired
  • project_can_modify_origin_project
    boolean
  • project_can_delete_origin_company
    boolean
  • is_included_in_project_pattern
    boolean
  • structure
    stringrequired
  • tiered
    boolean
  • selectable_tiers
    boolean
  • tier_depth
    integer
  • wbs_pattern_id
    integer
  • company_id
    integer
  • project_id
    integer
  • translated_type
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
GET /rest/v1.0/projects/{project_id}/work_breakdown_structure/segments/{id}/segment_items

List project segment items

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · SegmentItem[]

  • id
    integerrequired
  • code
    stringrequired
  • name
    stringrequired
  • parent_id
    integer
  • status
    stringrequired
  • is_parent
    boolean
  • in_use
    boolean
  • path_ids
    integer[]
  • path_code
    string
  • path_codes
    string[]
  • path_names
    string[]
  • segment
    SegmentStub
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
POST /rest/v1.0/projects/{project_id}/work_breakdown_structure/segments/{id}/segment_items

Create a project segment item

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 201 · SegmentItem

  • id
    integerrequired
  • code
    stringrequired
  • name
    stringrequired
  • parent_id
    integer
  • status
    stringrequired
  • is_parent
    boolean
  • in_use
    boolean
  • path_ids
    integer[]
  • path_code
    string
  • path_codes
    string[]
  • path_names
    string[]
  • segment
    SegmentStub
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
PATCH /rest/v1.0/projects/{project_id}/work_breakdown_structure/segments/{id}/segment_items/{item_id}

Update a project segment item

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired
  • item_id
    stringpathrequired

Response · 200 · SegmentItem

  • id
    integerrequired
  • code
    stringrequired
  • name
    stringrequired
  • parent_id
    integer
  • status
    stringrequired
  • is_parent
    boolean
  • in_use
    boolean
  • path_ids
    integer[]
  • path_code
    string
  • path_codes
    string[]
  • path_names
    string[]
  • segment
    SegmentStub
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
GET /rest/v1.0/projects/{project_id}/work_breakdown_structure/wbs_codes

List assembled WBS codes

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · WbsCode[]

  • id
    integerrequired
  • flat_code
    stringrequired
  • flat_name
    stringrequired
  • status
    stringrequired
  • is_in_group
    boolean
  • wbs_pattern_id
    integer
  • attribute_items
    any[]
  • segment_items
    object[]required
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
POST /rest/v1.0/projects/{project_id}/work_breakdown_structure/wbs_codes

Create an assembled WBS code

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 201 · WbsCode

  • id
    integerrequired
  • flat_code
    stringrequired
  • flat_name
    stringrequired
  • status
    stringrequired
  • is_in_group
    boolean
  • wbs_pattern_id
    integer
  • attribute_items
    any[]
  • segment_items
    object[]required
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
GET /rest/v1.0/projects/{project_id}/work_breakdown_structure/wbs_codes/{id}

Show an assembled WBS code

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · WbsCode

  • id
    integerrequired
  • flat_code
    stringrequired
  • flat_name
    stringrequired
  • status
    stringrequired
  • is_in_group
    boolean
  • wbs_pattern_id
    integer
  • attribute_items
    any[]
  • segment_items
    object[]required
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
PATCH /rest/v1.0/projects/{project_id}/work_breakdown_structure/wbs_codes/{id}

Update an assembled WBS code

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · WbsCode

  • id
    integerrequired
  • flat_code
    stringrequired
  • flat_name
    stringrequired
  • status
    stringrequired
  • is_in_group
    boolean
  • wbs_pattern_id
    integer
  • attribute_items
    any[]
  • segment_items
    object[]required
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
GET /rest/v1.0/standard_cost_codes

List standard cost codes

v1.0Implemented

Response · 200 · StandardCostCode[]

  • id
    integerrequired
  • standard_cost_code_list_id
    integer
  • parent_id
    integer
  • code
    stringrequired
  • full_code
    stringrequired
  • name
    stringrequired
  • division
    string
  • origin_data
    string
  • origin_id
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
POST /rest/v1.0/standard_cost_codes

Create a standard cost code

v1.0Implemented

Response · 201 · StandardCostCode

  • id
    integerrequired
  • standard_cost_code_list_id
    integer
  • parent_id
    integer
  • code
    stringrequired
  • full_code
    stringrequired
  • name
    stringrequired
  • division
    string
  • origin_data
    string
  • origin_id
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
GET /rest/v1.0/standard_cost_codes/{id}

Show a standard cost code

v1.0Implemented

Parameters

  • id
    stringpathrequired

Response · 200 · StandardCostCode

  • id
    integerrequired
  • standard_cost_code_list_id
    integer
  • parent_id
    integer
  • code
    stringrequired
  • full_code
    stringrequired
  • name
    stringrequired
  • division
    string
  • origin_data
    string
  • origin_id
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
PATCH /rest/v1.0/standard_cost_codes/{id}

Update a standard cost code

v1.0Implemented

Parameters

  • id
    stringpathrequired

Response · 200 · StandardCostCode

  • id
    integerrequired
  • standard_cost_code_list_id
    integer
  • parent_id
    integer
  • code
    stringrequired
  • full_code
    stringrequired
  • name
    stringrequired
  • division
    string
  • origin_data
    string
  • origin_id
    string
  • created_at
    string (date-time)
  • updated_at
    string (date-time)

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